Mercurial > vim
comparison runtime/doc/options.txt @ 10:4e2284e71352
updated for version 7.0002
author | vimboss |
---|---|
date | Thu, 24 Jun 2004 15:53:16 +0000 |
parents | 7edf9b6e4c36 |
children | 4424b47a0797 |
comparison
equal
deleted
inserted
replaced
9:4102fb4ea781 | 10:4e2284e71352 |
---|---|
1 *options.txt* For Vim version 7.0aa. Last change: 2004 Jun 15 | 1 *options.txt* For Vim version 7.0aa. Last change: 2004 Jun 21 |
2 | 2 |
3 | 3 |
4 VIM REFERENCE MANUAL by Bram Moolenaar | 4 VIM REFERENCE MANUAL by Bram Moolenaar |
5 | 5 |
6 | 6 |
48 current value of 'compatible'. {not in Vi} | 48 current value of 'compatible'. {not in Vi} |
49 :se[t] {option}&vi Reset option to its Vi default value. {not in Vi} | 49 :se[t] {option}&vi Reset option to its Vi default value. {not in Vi} |
50 :se[t] {option}&vim Reset option to its Vim default value. {not in Vi} | 50 :se[t] {option}&vim Reset option to its Vim default value. {not in Vi} |
51 | 51 |
52 :se[t] all& Set all options, except terminal options, to their | 52 :se[t] all& Set all options, except terminal options, to their |
53 default value. The values of 'term', 'lines' and | 53 default value. The values of 'term', 'lines' and |
54 'columns' are not changed. {not in Vi} | 54 'columns' are not changed. {not in Vi} |
55 | 55 |
56 *:set-args* *E487* *E521* | 56 *:set-args* *E487* *E521* |
57 :se[t] {option}={value} or | 57 :se[t] {option}={value} or |
58 :se[t] {option}:{value} | 58 :se[t] {option}:{value} |
138 :set <M-b>=^[b | 138 :set <M-b>=^[b |
139 (the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it) | 139 (the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it) |
140 The advantage over a mapping is that it works in all situations. | 140 The advantage over a mapping is that it works in all situations. |
141 | 141 |
142 The listing from ":set" looks different from Vi. Long string options are put | 142 The listing from ":set" looks different from Vi. Long string options are put |
143 at the end of the list. The number of options is quite large. The output of | 143 at the end of the list. The number of options is quite large. The output of |
144 "set all" probably does not fit on the screen, causing Vim to give the | 144 "set all" probably does not fit on the screen, causing Vim to give the |
145 |more-prompt|. | 145 |more-prompt|. |
146 | 146 |
147 *option-backslash* | 147 *option-backslash* |
148 To include white space in a string option value it has to be preceded with a | 148 To include white space in a string option value it has to be preceded with a |
152 A few examples: > | 152 A few examples: > |
153 :set tags=tags\ /usr/tags results in "tags /usr/tags" | 153 :set tags=tags\ /usr/tags results in "tags /usr/tags" |
154 :set tags=tags\\,file results in "tags\,file" | 154 :set tags=tags\\,file results in "tags\,file" |
155 :set tags=tags\\\ file results in "tags\ file" | 155 :set tags=tags\\\ file results in "tags\ file" |
156 | 156 |
157 The "|" character separates a ":set" command from a following command. To | 157 The "|" character separates a ":set" command from a following command. To |
158 include the "|" in the option value, use "\|" instead. This example sets the | 158 include the "|" in the option value, use "\|" instead. This example sets the |
159 'titlestring' option to "hi|there": > | 159 'titlestring' option to "hi|there": > |
160 :set titlestring=hi\|there | 160 :set titlestring=hi\|there |
161 This sets the 'titlestring' option to "hi" and 'iconstring' to "there": > | 161 This sets the 'titlestring' option to "hi" and 'iconstring' to "there": > |
162 :set titlestring=hi|set iconstring=there | 162 :set titlestring=hi|set iconstring=there |
163 | 163 |
164 For MS-DOS and WIN32 backslashes in file names are mostly not removed. More | 164 For MS-DOS and WIN32 backslashes in file names are mostly not removed. More |
165 precise: For options that expect a file name (those where environment | 165 precise: For options that expect a file name (those where environment |
166 variables are expanded) a backslash before a normal file name character is not | 166 variables are expanded) a backslash before a normal file name character is not |
167 removed. But a backslash before a special character (space, backslash, comma, | 167 removed. But a backslash before a special character (space, backslash, comma, |
168 etc.) is used like explained above. | 168 etc.) is used like explained above. |
169 There is one special situation, when the value starts with "\\": > | 169 There is one special situation, when the value starts with "\\": > |
170 :set dir=\\machine\path results in "\\machine\path" | 170 :set dir=\\machine\path results in "\\machine\path" |
171 :set dir=\\\\machine\\path results in "\\machine\path" | 171 :set dir=\\\\machine\\path results in "\\machine\path" |
172 :set dir=\\path\\file results in "\\path\file" (wrong!) | 172 :set dir=\\path\\file results in "\\path\file" (wrong!) |
173 For the first one the start is kept, but for the second one the backslashes | 173 For the first one the start is kept, but for the second one the backslashes |
174 are halved. This makes sure it works both when you expect backslashes to be | 174 are halved. This makes sure it works both when you expect backslashes to be |
175 halved and when you expect the backslashes to be kept. The third gives a | 175 halved and when you expect the backslashes to be kept. The third gives a |
176 result which is probably not what you want. Avoid it. | 176 result which is probably not what you want. Avoid it. |
177 | 177 |
178 *add-option-flags* *remove-option-flags* | 178 *add-option-flags* *remove-option-flags* |
179 *E539* *E550* *E551* *E552* | 179 *E539* *E550* *E551* *E552* |
180 Some options are a list of flags. When you want to add a flag to such an | 180 Some options are a list of flags. When you want to add a flag to such an |
181 option, without changing the existing ones, you can do it like this: > | 181 option, without changing the existing ones, you can do it like this: > |
182 :set guioptions+=a | 182 :set guioptions+=a |
183 Remove a flag from an option like this: > | 183 Remove a flag from an option like this: > |
184 :set guioptions-=a | 184 :set guioptions-=a |
185 This removes the 'a' flag from 'guioptions'. | 185 This removes the 'a' flag from 'guioptions'. |
186 Note that you should add or remove one flag at a time. If 'guioptions' has | 186 Note that you should add or remove one flag at a time. If 'guioptions' has |
187 the value "ab", using "set guioptions-=ba" won't work, because the string "ba" | 187 the value "ab", using "set guioptions-=ba" won't work, because the string "ba" |
188 doesn't appear. | 188 doesn't appear. |
189 | 189 |
190 *:set_env* *expand-env* *expand-environment-var* | 190 *:set_env* *expand-env* *expand-environment-var* |
191 Environment variables in most string options will be expanded. If the | 191 Environment variables in most string options will be expanded. If the |
192 environment variable exists the '$' and the following environment variable | 192 environment variable exists the '$' and the following environment variable |
193 name is replaced with its value. If it does not exist the '$' and the name | 193 name is replaced with its value. If it does not exist the '$' and the name |
194 are not modified. Any non-id character (not a letter, digit or '_') may | 194 are not modified. Any non-id character (not a letter, digit or '_') may |
195 follow the environment variable name. That character and what follows is | 195 follow the environment variable name. That character and what follows is |
196 appended to the value of the environment variable. Examples: > | 196 appended to the value of the environment variable. Examples: > |
245 Now the 'list' option is not set, because ":set nolist" resets the global | 245 Now the 'list' option is not set, because ":set nolist" resets the global |
246 value, ":setlocal list" only changes the local value and ":e two" gets the | 246 value, ":setlocal list" only changes the local value and ":e two" gets the |
247 global value. Note that if you do this next: > | 247 global value. Note that if you do this next: > |
248 :e one | 248 :e one |
249 You will not get back the 'list' value as it was the last time you edited | 249 You will not get back the 'list' value as it was the last time you edited |
250 "one". The options local to a window are not remembered for each buffer. | 250 "one". The options local to a window are not remembered for each buffer. |
251 | 251 |
252 *:setl* *:setlocal* | 252 *:setl* *:setlocal* |
253 :setl[ocal] ... Like ":set" but set only the value local to the | 253 :setl[ocal] ... Like ":set" but set only the value local to the |
254 current buffer or window. Not all options have a | 254 current buffer or window. Not all options have a |
255 local value. If the option does not have a local | 255 local value. If the option does not have a local |
298 :set makeprg=gmake | 298 :set makeprg=gmake |
299 then the other window will switch to the same value. There is no need to set | 299 then the other window will switch to the same value. There is no need to set |
300 the 'makeprg' option in the other C source window too. | 300 the 'makeprg' option in the other C source window too. |
301 However, if you start editing a Perl file in a new window, you want to use | 301 However, if you start editing a Perl file in a new window, you want to use |
302 another 'makeprog' for it, without changing the value used for the C source | 302 another 'makeprog' for it, without changing the value used for the C source |
303 files. You use this command: > | 303 files. You use this command: > |
304 :setlocal makeprg=perlmake | 304 :setlocal makeprg=perlmake |
305 You can switch back to using the global value by making the local value empty: > | 305 You can switch back to using the global value by making the local value empty: > |
306 :setlocal makeprg= | 306 :setlocal makeprg= |
307 This only works for a string option. For a boolean option you need to use the | 307 This only works for a string option. For a boolean option you need to use the |
308 "<" flag, like this: > | 308 "<" flag, like this: > |
382 :if &term == "termname" | 382 :if &term == "termname" |
383 : set t_kb=^V<BS> | 383 : set t_kb=^V<BS> |
384 : fixdel | 384 : fixdel |
385 :endif | 385 :endif |
386 < Where "^V" is CTRL-V and "<BS>" is the backspace key | 386 < Where "^V" is CTRL-V and "<BS>" is the backspace key |
387 (don't type four characters!). Replace "termname" | 387 (don't type four characters!). Replace "termname" |
388 with your terminal name. | 388 with your terminal name. |
389 | 389 |
390 If your <Delete> key sends a strange key sequence (not | 390 If your <Delete> key sends a strange key sequence (not |
391 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: > | 391 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: > |
392 :if &term == "termname" | 392 :if &term == "termname" |
498 /* vi:set ts=4: */ | 498 /* vi:set ts=4: */ |
499 | 499 |
500 If an error is detected the rest of the line is skipped. | 500 If an error is detected the rest of the line is skipped. |
501 | 501 |
502 If you want to include a ':' in a set command precede it with a '\'. The | 502 If you want to include a ':' in a set command precede it with a '\'. The |
503 backslash in front of the ':' will be removed. Example: > | 503 backslash in front of the ':' will be removed. Example: > |
504 /* vi:set dir=c\:\tmp: */ | 504 /* vi:set dir=c\:\tmp: */ |
505 This sets the 'dir' option to "c:\tmp". Only a single backslash before the | 505 This sets the 'dir' option to "c:\tmp". Only a single backslash before the |
506 ':' is removed. Thus to include "\:" you have to specify "\\:". | 506 ':' is removed. Thus to include "\:" you have to specify "\\:". |
507 | 507 |
508 No other commands than "set" are supported, for security reasons (somebody | 508 No other commands than "set" are supported, for security reasons (somebody |
527 For some options there are two default values: The "Vim default", which is | 527 For some options there are two default values: The "Vim default", which is |
528 used when 'compatible' is not set, and the "Vi default", which is used when | 528 used when 'compatible' is not set, and the "Vi default", which is used when |
529 'compatible' is set. | 529 'compatible' is set. |
530 | 530 |
531 Most options are the same in all windows and buffers. There are a few that | 531 Most options are the same in all windows and buffers. There are a few that |
532 are specific to how the text is presented in a window. These can be set to a | 532 are specific to how the text is presented in a window. These can be set to a |
533 different value in each window. For example the 'list' option can be set in | 533 different value in each window. For example the 'list' option can be set in |
534 one window and reset in another for the same text, giving both types of view | 534 one window and reset in another for the same text, giving both types of view |
535 at the same time. There are a few options that are specific to a certain | 535 at the same time. There are a few options that are specific to a certain |
536 file. These can have a different value for each file or buffer. For example | 536 file. These can have a different value for each file or buffer. For example |
537 the 'textwidth' option can be 78 for a normal text file and 0 for a C | 537 the 'textwidth' option can be 78 for a normal text file and 0 for a C |
544 When creating a new window the option values from the currently active window | 544 When creating a new window the option values from the currently active window |
545 are used as a default value for the window-specific options. For the | 545 are used as a default value for the window-specific options. For the |
546 buffer-specific options this depends on the 's' and 'S' flags in the | 546 buffer-specific options this depends on the 's' and 'S' flags in the |
547 'cpoptions' option. If 's' is included (which is the default) the values for | 547 'cpoptions' option. If 's' is included (which is the default) the values for |
548 buffer options are copied from the currently active buffer when a buffer is | 548 buffer options are copied from the currently active buffer when a buffer is |
549 first entered. If 'S' is present the options are copied each time the buffer | 549 first entered. If 'S' is present the options are copied each time the buffer |
550 is entered, this is almost like having global options. If 's' and 'S' are not | 550 is entered, this is almost like having global options. If 's' and 'S' are not |
551 present, the options are copied from the currently active buffer when the | 551 present, the options are copied from the currently active buffer when the |
552 buffer is created. | 552 buffer is created. |
553 | 553 |
554 Not all options are supported in all versions. To test if option "foo" can be | 554 Not all options are supported in all versions. To test if option "foo" can be |
555 used with ":set" use "exists('&foo')". This doesn't mean the value is | 555 used with ":set" use "exists('&foo')". This doesn't mean the value is |
556 actually remembered and works. Some options are hidden, which means that you | 556 actually remembered and works. Some options are hidden, which means that you |
557 can set them but the value is not remembered. To test if option "foo" is | 557 can set them but the value is not remembered. To test if option "foo" is |
558 really supported use "exists('+foo')". | 558 really supported use "exists('+foo')". |
559 | 559 |
560 *E355* | 560 *E355* |
561 A jump table for the options with a short description can be found at |Q_op|. | 561 A jump table for the options with a short description can be found at |Q_op|. |
595 the keyboard map between Farsi and English, when 'allowrevins' set. | 595 the keyboard map between Farsi and English, when 'allowrevins' set. |
596 | 596 |
597 When off, the keyboard map toggles between Hebrew and English. This | 597 When off, the keyboard map toggles between Hebrew and English. This |
598 is useful to start the Vim in native mode i.e. English (left-to-right | 598 is useful to start the Vim in native mode i.e. English (left-to-right |
599 mode) and have default second language Farsi or Hebrew (right-to-left | 599 mode) and have default second language Farsi or Hebrew (right-to-left |
600 mode). See |farsi.txt|. | 600 mode). See |farsi.txt|. |
601 | 601 |
602 *'ambiwidth'* *'ambw'* | 602 *'ambiwidth'* *'ambw'* |
603 'ambiwidth' 'ambw' string (default: "single") | 603 'ambiwidth' 'ambw' string (default: "single") |
604 global | 604 global |
605 {not in Vi} | 605 {not in Vi} |
701 'autoindent' 'ai' boolean (default off) | 701 'autoindent' 'ai' boolean (default off) |
702 local to buffer | 702 local to buffer |
703 Copy indent from current line when starting a new line (typing <CR> | 703 Copy indent from current line when starting a new line (typing <CR> |
704 in Insert mode or when using the "o" or "O" command). If you do not | 704 in Insert mode or when using the "o" or "O" command). If you do not |
705 type anything on the new line except <BS> or CTRL-D and then type | 705 type anything on the new line except <BS> or CTRL-D and then type |
706 <Esc> or <CR>, the indent is deleted again. When autoindent is on, | 706 <Esc> or <CR>, the indent is deleted again. Moving the cursor to |
707 formatting (with the "gq" command or when you reach 'textwidth' in | 707 another line has the same effect, unless the 'I' flag is included in |
708 Insert mode) uses the indentation of the first line. | 708 'cpoptions'. |
709 When autoindent is on, formatting (with the "gq" command or when you | |
710 reach 'textwidth' in Insert mode) uses the indentation of the first | |
711 line. | |
709 When 'smartindent' or 'cindent' is on the indent is changed in | 712 When 'smartindent' or 'cindent' is on the indent is changed in |
710 a different way. | 713 a different way. |
711 The 'autoindent' option is reset when the 'paste' option is set. | 714 The 'autoindent' option is reset when the 'paste' option is set. |
712 {small difference from Vi: After the indent is deleted when typing | 715 {small difference from Vi: After the indent is deleted when typing |
713 <Esc> or <CR>, the cursor position when moving up or down is after the | 716 <Esc> or <CR>, the cursor position when moving up or down is after the |
755 Setting this option does not change the background color, it tells Vim | 758 Setting this option does not change the background color, it tells Vim |
756 what the background color looks like. For changing the background | 759 what the background color looks like. For changing the background |
757 color, see |:hi-normal|. | 760 color, see |:hi-normal|. |
758 | 761 |
759 When 'background' is set Vim will adjust the default color groups for | 762 When 'background' is set Vim will adjust the default color groups for |
760 the new value. But the colors used for syntax highlighting will not | 763 the new value. But the colors used for syntax highlighting will not |
761 change. | 764 change. |
762 When a color scheme is loaded (the "colors_name" variable is set) | 765 When a color scheme is loaded (the "colors_name" variable is set) |
763 setting 'background' will cause the color scheme to be reloaded. If | 766 setting 'background' will cause the color scheme to be reloaded. If |
764 the color scheme adjusts to the value of 'background' this will work. | 767 the color scheme adjusts to the value of 'background' this will work. |
765 However, if the color scheme sets 'background' itself the effect may | 768 However, if the color scheme sets 'background' itself the effect may |
822 Make a backup before overwriting a file. Leave it around after the | 825 Make a backup before overwriting a file. Leave it around after the |
823 file has been successfully written. If you do not want to keep the | 826 file has been successfully written. If you do not want to keep the |
824 backup file, but you do want a backup while the file is being | 827 backup file, but you do want a backup while the file is being |
825 written, reset this option and set the 'writebackup' option (this is | 828 written, reset this option and set the 'writebackup' option (this is |
826 the default). If you do not want a backup file at all reset both | 829 the default). If you do not want a backup file at all reset both |
827 options (use this if your file system is almost full). See the | 830 options (use this if your file system is almost full). See the |
828 |backup-table| for more explanations. | 831 |backup-table| for more explanations. |
829 When the 'backupskip' pattern matches, a backup is not made anyway. | 832 When the 'backupskip' pattern matches, a backup is not made anyway. |
830 When 'patchmode' is set, the backup may be renamed to become the | 833 When 'patchmode' is set, the backup may be renamed to become the |
831 oldest version of a file. | 834 oldest version of a file. |
832 NOTE: This option is reset when 'compatible' is set. | 835 NOTE: This option is reset when 'compatible' is set. |
875 be propagated back to the original source. | 878 be propagated back to the original source. |
876 *crontab* | 879 *crontab* |
877 One situation where "no" and "auto" will cause problems: A program | 880 One situation where "no" and "auto" will cause problems: A program |
878 that opens a file, invokes Vim to edit that file, and then tests if | 881 that opens a file, invokes Vim to edit that file, and then tests if |
879 the open file was changed (through the file descriptor) will check the | 882 the open file was changed (through the file descriptor) will check the |
880 backup file instead of the newly created file. "crontab -e" is an | 883 backup file instead of the newly created file. "crontab -e" is an |
881 example. | 884 example. |
882 | 885 |
883 When a copy is made, the original file is truncated and then filled | 886 When a copy is made, the original file is truncated and then filled |
884 with the new text. This means that protection bits, owner and | 887 with the new text. This means that protection bits, owner and |
885 symbolic links of the original file are unmodified. The backup file | 888 symbolic links of the original file are unmodified. The backup file |
886 however, is a new file, owned by the user who edited the file. The | 889 however, is a new file, owned by the user who edited the file. The |
887 group of the backup is set to the group of the original file. If this | 890 group of the backup is set to the group of the original file. If this |
888 fails, the protection bits for the group are made the same as for | 891 fails, the protection bits for the group are made the same as for |
889 others. | 892 others. |
890 | 893 |
891 When the file is renamed this is the other way around: The backup has | 894 When the file is renamed this is the other way around: The backup has |
1132 {not in Vi} | 1135 {not in Vi} |
1133 Specifies details about changing the case of letters. It may contain | 1136 Specifies details about changing the case of letters. It may contain |
1134 these words, separated by a comma: | 1137 these words, separated by a comma: |
1135 internal Use internal case mapping functions, the current | 1138 internal Use internal case mapping functions, the current |
1136 locale does not change the case mapping. This only | 1139 locale does not change the case mapping. This only |
1137 matters when 'encoding' is a Unicode encoding. When | 1140 matters when 'encoding' is a Unicode encoding. When |
1138 "internal" is omitted, the towupper() and towlower() | 1141 "internal" is omitted, the towupper() and towlower() |
1139 system library functions are used when available. | 1142 system library functions are used when available. |
1140 keepascii For the ASCII characters (0x00 to 0x7f) use the US | 1143 keepascii For the ASCII characters (0x00 to 0x7f) use the US |
1141 case mapping, the current locale is not effective. | 1144 case mapping, the current locale is not effective. |
1142 This probably only matters for Turkish. | 1145 This probably only matters for Turkish. |
1387 This option has the effect of making Vim either more Vi-compatible, or | 1390 This option has the effect of making Vim either more Vi-compatible, or |
1388 make Vim behave in a more useful way. | 1391 make Vim behave in a more useful way. |
1389 This is a special kind of option, because when it's set or reset, | 1392 This is a special kind of option, because when it's set or reset, |
1390 other options are also changed as a side effect. CAREFUL: Setting or | 1393 other options are also changed as a side effect. CAREFUL: Setting or |
1391 resetting this option can have a lot of unexpected effects: Mappings | 1394 resetting this option can have a lot of unexpected effects: Mappings |
1392 are interpreted in another way, undo behaves differently, etc. If you | 1395 are interpreted in another way, undo behaves differently, etc. If you |
1393 set this option in your vimrc file, you should probably put it at the | 1396 set this option in your vimrc file, you should probably put it at the |
1394 very start. | 1397 very start. |
1395 By default this option is on and the Vi defaults are used for the | 1398 By default this option is on and the Vi defaults are used for the |
1396 options. This default was chosen for those people who want to use Vim | 1399 options. This default was chosen for those people who want to use Vim |
1397 just like Vi, and don't even (want to) know about the 'compatible' | 1400 just like Vi, and don't even (want to) know about the 'compatible' |
1399 When a ".vimrc" file is found while Vim is starting up, this option is | 1402 When a ".vimrc" file is found while Vim is starting up, this option is |
1400 switched off, and all options that have not been modified will be set | 1403 switched off, and all options that have not been modified will be set |
1401 to the Vim defaults. Effectively, this means that when a ".vimrc" | 1404 to the Vim defaults. Effectively, this means that when a ".vimrc" |
1402 file exists, Vim will use the Vim defaults, otherwise it will use the | 1405 file exists, Vim will use the Vim defaults, otherwise it will use the |
1403 Vi defaults. (Note: This doesn't happen for the system-wide vimrc | 1406 Vi defaults. (Note: This doesn't happen for the system-wide vimrc |
1404 file). Also see |compatible-default|. | 1407 file). Also see |compatible-default|. |
1405 You can also set this option with the "-C" argument, and reset it with | 1408 You can also set this option with the "-C" argument, and reset it with |
1406 "-N". See |-C| and |-N|. | 1409 "-N". See |-C| and |-N|. |
1407 Switching this option off makes the Vim defaults be used for options | 1410 Switching this option off makes the Vim defaults be used for options |
1408 that have a different Vi and Vim default value. See the options | 1411 that have a different Vi and Vim default value. See the options |
1409 marked with a '+' below. Other options are not modified. | 1412 marked with a '+' below. Other options are not modified. |
1410 At the moment this option is set, several other options will be set | 1413 At the moment this option is set, several other options will be set |
1411 or reset to make Vim as Vi-compatible as possible. See the table | 1414 or reset to make Vim as Vi-compatible as possible. See the table |
1412 below. This can be used if you want to revert to Vi compatible | 1415 below. This can be used if you want to revert to Vi compatible |
1413 editing. | 1416 editing. |
1414 See also 'cpoptions'. | 1417 See also 'cpoptions'. |
1415 | 1418 |
1416 option + set value effect ~ | 1419 option + set value effect ~ |
1417 | 1420 |
1527 *'conskey'* *'consk'* *'noconskey'* *'noconsk'* | 1530 *'conskey'* *'consk'* *'noconskey'* *'noconsk'* |
1528 'conskey' 'consk' boolean (default off) | 1531 'conskey' 'consk' boolean (default off) |
1529 global | 1532 global |
1530 {not in Vi} {only for MS-DOS} | 1533 {not in Vi} {only for MS-DOS} |
1531 When on direct console I/O is used to obtain a keyboard character. | 1534 When on direct console I/O is used to obtain a keyboard character. |
1532 This should work in most cases. Also see |'bioskey'|. Together, | 1535 This should work in most cases. Also see |'bioskey'|. Together, |
1533 three methods of console input are available: | 1536 three methods of console input are available: |
1534 'conskey' 'bioskey' action ~ | 1537 'conskey' 'bioskey' action ~ |
1535 on on or off direct console input | 1538 on on or off direct console input |
1536 off on BIOS | 1539 off on BIOS |
1537 off off STDIN | 1540 off off STDIN |
1554 'cpoptions' 'cpo' string (Vim default: "aABceFs", | 1557 'cpoptions' 'cpo' string (Vim default: "aABceFs", |
1555 Vi default: all flags) | 1558 Vi default: all flags) |
1556 global | 1559 global |
1557 {not in Vi} | 1560 {not in Vi} |
1558 A sequence of single character flags. When a character is present | 1561 A sequence of single character flags. When a character is present |
1559 this indicates vi-compatible behavior. This is used for things where | 1562 this indicates vi-compatible behavior. This is used for things where |
1560 not being vi-compatible is mostly or sometimes preferred. | 1563 not being vi-compatible is mostly or sometimes preferred. |
1561 'cpoptions' stands for "compatible-options". | 1564 'cpoptions' stands for "compatible-options". |
1562 Commas can be added for readability. | 1565 Commas can be added for readability. |
1563 To avoid problems with flags that are added in the future, use the | 1566 To avoid problems with flags that are added in the future, use the |
1564 "+=" and "-=" feature of ":set" |add-option-flags|. | 1567 "+=" and "-=" feature of ":set" |add-option-flags|. |
1633 *cpo-g* | 1636 *cpo-g* |
1634 g Goto line 1 when using ":edit" without argument. | 1637 g Goto line 1 when using ":edit" without argument. |
1635 *cpo-i* | 1638 *cpo-i* |
1636 i When included, interrupting the reading of a file will | 1639 i When included, interrupting the reading of a file will |
1637 leave it modified. | 1640 leave it modified. |
1641 *cpo-I* | |
1642 I When moving the cursor up or down just after inserting | |
1643 indent for 'autoindent', do not delete the indent. | |
1638 *cpo-j* | 1644 *cpo-j* |
1639 j When joining lines, only add two spaces after a '.', | 1645 j When joining lines, only add two spaces after a '.', |
1640 not after '!' or '?'. Also see 'joinspaces'. | 1646 not after '!' or '?'. Also see 'joinspaces'. |
1641 *cpo-J* | 1647 *cpo-J* |
1642 J A |sentence| has to be followed by two spaces after | 1648 J A |sentence| has to be followed by two spaces after |
1696 R Remove marks from filtered lines. Without this flag | 1702 R Remove marks from filtered lines. Without this flag |
1697 marks are kept like |:keepmarks| was used. | 1703 marks are kept like |:keepmarks| was used. |
1698 *cpo-s* | 1704 *cpo-s* |
1699 s Set buffer options when entering the buffer for the | 1705 s Set buffer options when entering the buffer for the |
1700 first time. This is like it is in Vim version 3.0. | 1706 first time. This is like it is in Vim version 3.0. |
1701 And it is the default. If not present the options are | 1707 And it is the default. If not present the options are |
1702 set when the buffer is created. | 1708 set when the buffer is created. |
1703 *cpo-S* | 1709 *cpo-S* |
1704 S Set buffer options always when entering a buffer | 1710 S Set buffer options always when entering a buffer |
1705 (except 'readonly', 'fileformat', 'filetype' and | 1711 (except 'readonly', 'fileformat', 'filetype' and |
1706 'syntax'). This is the (most) Vi compatible setting. | 1712 'syntax'). This is the (most) Vi compatible setting. |
1717 t Search pattern for the tag command is remembered for | 1723 t Search pattern for the tag command is remembered for |
1718 "n" command. Otherwise Vim only puts the pattern in | 1724 "n" command. Otherwise Vim only puts the pattern in |
1719 the history for search pattern, but doesn't change the | 1725 the history for search pattern, but doesn't change the |
1720 last used search pattern. | 1726 last used search pattern. |
1721 *cpo-u* | 1727 *cpo-u* |
1722 u Undo is Vi compatible. See |undo-two-ways|. | 1728 u Undo is Vi compatible. See |undo-two-ways|. |
1723 *cpo-v* | 1729 *cpo-v* |
1724 v Backspaced characters remain visible on the screen in | 1730 v Backspaced characters remain visible on the screen in |
1725 Insert mode. Without this flag the characters are | 1731 Insert mode. Without this flag the characters are |
1726 erased from the screen right away. With this flag the | 1732 erased from the screen right away. With this flag the |
1727 screen newly typed text overwrites backspaced | 1733 screen newly typed text overwrites backspaced |
1761 match the last one. When this flag is not included, | 1767 match the last one. When this flag is not included, |
1762 parens inside single and double quotes are treated | 1768 parens inside single and double quotes are treated |
1763 specially. When matching a paren outside of quotes, | 1769 specially. When matching a paren outside of quotes, |
1764 everything inside quotes is ignored. When matching a | 1770 everything inside quotes is ignored. When matching a |
1765 paren inside quotes, it will find the matching one (if | 1771 paren inside quotes, it will find the matching one (if |
1766 there is one). This works very well for C programs. | 1772 there is one). This works very well for C programs. |
1767 *cpo-star* | 1773 *cpo-star* |
1768 * Use ":*" in the same way as ":@". When not included, | 1774 * Use ":*" in the same way as ":@". When not included, |
1769 ":*" is an alias for ":'<,'>", select the Visual area. | 1775 ":*" is an alias for ":'<,'>", select the Visual area. |
1770 *cpo-<* | 1776 *cpo-<* |
1771 < Disable the recognition of special key codes in |<>| | 1777 < Disable the recognition of special key codes in |<>| |
1772 form in mappings, abbreviations, and the "to" part of | 1778 form in mappings, abbreviations, and the "to" part of |
1773 menu commands. For example, the command | 1779 menu commands. For example, the command |
1774 ":map X <Tab>" results in X being mapped to: | 1780 ":map X <Tab>" results in X being mapped to: |
1775 '<' included: "<Tab>" (5 characters) | 1781 '<' included: "<Tab>" (5 characters) |
1776 '<' excluded: "^I" (^I is a real <Tab>) | 1782 '<' excluded: "^I" (^I is a real <Tab>) |
1777 Also see the 'k' flag above. | 1783 Also see the 'k' flag above. |
1778 | 1784 |
1843 | 1849 |
1844 *'define'* *'def'* | 1850 *'define'* *'def'* |
1845 'define' 'def' string (default "^\s*#\s*define") | 1851 'define' 'def' string (default "^\s*#\s*define") |
1846 global or local to buffer |global-local| | 1852 global or local to buffer |global-local| |
1847 {not in Vi} | 1853 {not in Vi} |
1848 Pattern to be used to find a macro definition. It is a search | 1854 Pattern to be used to find a macro definition. It is a search |
1849 pattern, just like for the "/" command. This option is used for the | 1855 pattern, just like for the "/" command. This option is used for the |
1850 commands like "[i" and "[d" |include-search|. The 'isident' option is | 1856 commands like "[i" and "[d" |include-search|. The 'isident' option is |
1851 used to recognize the defined name after the match: | 1857 used to recognize the defined name after the match: |
1852 {match with 'define'}{non-ID chars}{defined name}{non-ID char} | 1858 {match with 'define'}{non-ID chars}{defined name}{non-ID char} |
1853 See |option-backslash| about inserting backslashes to include a space | 1859 See |option-backslash| about inserting backslashes to include a space |
1880 List of file names, separated by commas, that are used to lookup words | 1886 List of file names, separated by commas, that are used to lookup words |
1881 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should | 1887 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should |
1882 contain a list of words. This can be one word per line, or several | 1888 contain a list of words. This can be one word per line, or several |
1883 words per line, separated by non-keyword characters (white space is | 1889 words per line, separated by non-keyword characters (white space is |
1884 preferred). Maximum line length is 510 bytes. | 1890 preferred). Maximum line length is 510 bytes. |
1885 To include a comma in a file name precede it with a backslash. Spaces | 1891 To include a comma in a file name precede it with a backslash. Spaces |
1886 after a comma are ignored, otherwise spaces are included in the file | 1892 after a comma are ignored, otherwise spaces are included in the file |
1887 name. See |option-backslash| about using backslashes. | 1893 name. See |option-backslash| about using backslashes. |
1888 Where to find a list of words? | 1894 Where to find a list of words? |
1889 - On FreeBSD, there is the file "/usr/share/dict/words". | 1895 - On FreeBSD, there is the file "/usr/share/dict/words". |
1890 - In the Simtel archive, look in the "msdos/linguist" directory. | 1896 - In the Simtel archive, look in the "msdos/linguist" directory. |
1899 local to window | 1905 local to window |
1900 {not in Vi} | 1906 {not in Vi} |
1901 {not available when compiled without the |+diff| | 1907 {not available when compiled without the |+diff| |
1902 feature} | 1908 feature} |
1903 Join the current window in the group of windows that shows differences | 1909 Join the current window in the group of windows that shows differences |
1904 between files. See |vimdiff|. | 1910 between files. See |vimdiff|. |
1905 | 1911 |
1906 *'dex'* *'diffexpr'* | 1912 *'dex'* *'diffexpr'* |
1907 'diffexpr' 'dex' string (default "") | 1913 'diffexpr' 'dex' string (default "") |
1908 global | 1914 global |
1909 {not in Vi} | 1915 {not in Vi} |
1918 'diffopt' 'dip' string (default "filler") | 1924 'diffopt' 'dip' string (default "filler") |
1919 global | 1925 global |
1920 {not in Vi} | 1926 {not in Vi} |
1921 {not available when compiled without the |+diff| | 1927 {not available when compiled without the |+diff| |
1922 feature} | 1928 feature} |
1923 Option settings for diff mode. It can consist of the following items. | 1929 Option settings for diff mode. It can consist of the following items. |
1924 All are optional. Items must be separated by a comma. | 1930 All are optional. Items must be separated by a comma. |
1925 | 1931 |
1926 filler Show filler lines, to keep the text | 1932 filler Show filler lines, to keep the text |
1927 synchronized with a window that has inserted | 1933 synchronized with a window that has inserted |
1928 lines at the same position. Mostly useful | 1934 lines at the same position. Mostly useful |
2012 global | 2018 global |
2013 {not in Vi} | 2019 {not in Vi} |
2014 Change the way text is displayed. This is comma separated list of | 2020 Change the way text is displayed. This is comma separated list of |
2015 flags: | 2021 flags: |
2016 lastline When included, as much as possible of the last line | 2022 lastline When included, as much as possible of the last line |
2017 in a window will be displayed. When not included, a | 2023 in a window will be displayed. When not included, a |
2018 last line that doesn't fit is replaced with "@" lines. | 2024 last line that doesn't fit is replaced with "@" lines. |
2019 uhex Show unprintable characters hexadecimal as <xx> | 2025 uhex Show unprintable characters hexadecimal as <xx> |
2020 instead of using ^C and ~C. | 2026 instead of using ^C and ~C. |
2021 | 2027 |
2022 *'eadirection'* *'ead'* | 2028 *'eadirection'* *'ead'* |
2056 | 2062 |
2057 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to | 2063 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to |
2058 "utf-8". Although care has been taken to allow different values of | 2064 "utf-8". Although care has been taken to allow different values of |
2059 'encoding', "utf-8" is the natural choice for the environment and | 2065 'encoding', "utf-8" is the natural choice for the environment and |
2060 avoids unnecessary conversion overhead. "utf-8" has not been made | 2066 avoids unnecessary conversion overhead. "utf-8" has not been made |
2061 the default to prevent different behaviour of the GUI and terminal | 2067 the default to prevent different behavior of the GUI and terminal |
2062 versions, and to avoid changing the encoding of newly created files | 2068 versions, and to avoid changing the encoding of newly created files |
2063 without your knowledge (in case 'fileencodings' is empty). | 2069 without your knowledge (in case 'fileencodings' is empty). |
2064 | 2070 |
2065 The character encoding of files can be different from 'encoding'. | 2071 The character encoding of files can be different from 'encoding'. |
2066 This is specified with 'fileencoding'. The conversion is done with | 2072 This is specified with 'fileencoding'. The conversion is done with |
2067 iconv() or as specified with 'charconvert'. | 2073 iconv() or as specified with 'charconvert'. |
2068 | 2074 |
2069 Normally 'encoding' will be equal to your current locale. This will | 2075 Normally 'encoding' will be equal to your current locale. This will |
2070 be the default if Vim recognizes your environment settings. If | 2076 be the default if Vim recognizes your environment settings. If |
2071 'encoding' is not set to the current locale, 'termencoding' must be | 2077 'encoding' is not set to the current locale, 'termencoding' must be |
2099 *'endofline'* *'eol'* *'noendofline'* *'noeol'* | 2105 *'endofline'* *'eol'* *'noendofline'* *'noeol'* |
2100 'endofline' 'eol' boolean (default on) | 2106 'endofline' 'eol' boolean (default on) |
2101 local to buffer | 2107 local to buffer |
2102 {not in Vi} | 2108 {not in Vi} |
2103 When writing a file and this option is off and the 'binary' option | 2109 When writing a file and this option is off and the 'binary' option |
2104 is on, no <EOL> will be written for the last line in the file. This | 2110 is on, no <EOL> will be written for the last line in the file. This |
2105 option is automatically set when starting to edit a new file, unless | 2111 option is automatically set when starting to edit a new file, unless |
2106 the file does not have an <EOL> for the last line in the file, in | 2112 the file does not have an <EOL> for the last line in the file, in |
2107 which case it is reset. Normally you don't have to set or reset this | 2113 which case it is reset. Normally you don't have to set or reset this |
2108 option. When 'binary' is off the value is not used when writing the | 2114 option. When 'binary' is off the value is not used when writing the |
2109 file. When 'binary' is on it is used to remember the presence of a | 2115 file. When 'binary' is on it is used to remember the presence of a |
2114 *'equalalways'* *'ea'* *'noequalalways'* *'noea'* | 2120 *'equalalways'* *'ea'* *'noequalalways'* *'noea'* |
2115 'equalalways' 'ea' boolean (default on) | 2121 'equalalways' 'ea' boolean (default on) |
2116 global | 2122 global |
2117 {not in Vi} | 2123 {not in Vi} |
2118 When on, all the windows are automatically made the same size after | 2124 When on, all the windows are automatically made the same size after |
2119 splitting or closing a window. When off, splitting a window will | 2125 splitting or closing a window. When off, splitting a window will |
2120 reduce the size of the current window and leave the other windows the | 2126 reduce the size of the current window and leave the other windows the |
2121 same. When closing a window the extra lines are given to the window | 2127 same. When closing a window the extra lines are given to the window |
2122 next to it (depending on 'splitbelow' and 'splitright'). | 2128 next to it (depending on 'splitbelow' and 'splitright'). |
2123 When mixing vertically and horizontally split windows, a minimal size | 2129 When mixing vertically and horizontally split windows, a minimal size |
2124 is computed and some windows may be larger if there is room. The | 2130 is computed and some windows may be larger if there is room. The |
2131 global or local to buffer |global-local| | 2137 global or local to buffer |global-local| |
2132 {not in Vi} | 2138 {not in Vi} |
2133 External program to use for "=" command. When this option is empty | 2139 External program to use for "=" command. When this option is empty |
2134 the internal formatting functions are used ('lisp', 'cindent' or | 2140 the internal formatting functions are used ('lisp', 'cindent' or |
2135 'indentexpr'). | 2141 'indentexpr'). |
2136 Environment variables are expanded |:set_env|. See |option-backslash| | 2142 Environment variables are expanded |:set_env|. See |option-backslash| |
2137 about including spaces and backslashes. | 2143 about including spaces and backslashes. |
2138 This option cannot be set from a |modeline| or in the |sandbox|, for | 2144 This option cannot be set from a |modeline| or in the |sandbox|, for |
2139 security reasons. | 2145 security reasons. |
2140 | 2146 |
2141 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'* | 2147 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'* |
2142 'errorbells' 'eb' boolean (default off) | 2148 'errorbells' 'eb' boolean (default off) |
2143 global | 2149 global |
2144 Ring the bell (beep or screen flash) for error messages. This only | 2150 Ring the bell (beep or screen flash) for error messages. This only |
2145 makes a difference for error messages, the bell will be used always | 2151 makes a difference for error messages, the bell will be used always |
2146 for a lot of errors without a message (e.g., hitting <Esc> in Normal | 2152 for a lot of errors without a message (e.g., hitting <Esc> in Normal |
2147 mode). See 'visualbell' on how to make the bell behave like a beep, | 2153 mode). See 'visualbell' on how to make the bell behave like a beep, |
2148 screen flash or do nothing. | 2154 screen flash or do nothing. |
2149 | 2155 |
2150 *'errorfile'* *'ef'* | 2156 *'errorfile'* *'ef'* |
2151 'errorfile' 'ef' string (Amiga default: "AztecC.Err", | 2157 'errorfile' 'ef' string (Amiga default: "AztecC.Err", |
2152 others: "errors.err") | 2158 others: "errors.err") |
2202 *'expandtab'* *'et'* *'noexpandtab'* *'noet'* | 2208 *'expandtab'* *'et'* *'noexpandtab'* *'noet'* |
2203 'expandtab' 'et' boolean (default off) | 2209 'expandtab' 'et' boolean (default off) |
2204 local to buffer | 2210 local to buffer |
2205 {not in Vi} | 2211 {not in Vi} |
2206 In Insert mode: Use the appropriate number of spaces to insert a | 2212 In Insert mode: Use the appropriate number of spaces to insert a |
2207 <Tab>. Spaces are used in indents with the '>' and '<' commands and | 2213 <Tab>. Spaces are used in indents with the '>' and '<' commands and |
2208 when 'autoindent' is on. To insert a real tab when 'expandtab' is | 2214 when 'autoindent' is on. To insert a real tab when 'expandtab' is |
2209 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|. | 2215 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|. |
2210 NOTE: This option is reset when 'compatible' is set. | 2216 NOTE: This option is reset when 'compatible' is set. |
2211 | 2217 |
2212 *'exrc'* *'ex'* *'noexrc'* *'noex'* | 2218 *'exrc'* *'ex'* *'noexrc'* *'noex'* |
2254 avoid this. | 2260 avoid this. |
2255 This option can not be changed when 'modifiable' is off. | 2261 This option can not be changed when 'modifiable' is off. |
2256 | 2262 |
2257 *'fe'* | 2263 *'fe'* |
2258 NOTE: Before version 6.0 this option specified the encoding for the | 2264 NOTE: Before version 6.0 this option specified the encoding for the |
2259 whole of Vim, this was a mistake. Now use 'encoding' instead. The | 2265 whole of Vim, this was a mistake. Now use 'encoding' instead. The |
2260 old short name was 'fe', which is no longer used. | 2266 old short name was 'fe', which is no longer used. |
2261 | 2267 |
2262 *'fileencodings'* *'fencs'* | 2268 *'fileencodings'* *'fencs'* |
2263 'fileencodings' 'fencs' string (default: "ucs-bom", "ucs-bom,utf-8,latin1" | 2269 'fileencodings' 'fencs' string (default: "ucs-bom", "ucs-bom,utf-8,latin1" |
2264 when 'encoding' is set to a Unicode value) | 2270 when 'encoding' is set to a Unicode value) |
2268 {not in Vi} | 2274 {not in Vi} |
2269 This is a list of character encodings considered when starting to edit | 2275 This is a list of character encodings considered when starting to edit |
2270 an existing file. When a file is read, Vim tries to use the first | 2276 an existing file. When a file is read, Vim tries to use the first |
2271 mentioned character encoding. If an error is detected, the next one | 2277 mentioned character encoding. If an error is detected, the next one |
2272 in the list is tried. When an encoding is found that works, | 2278 in the list is tried. When an encoding is found that works, |
2273 'fileencoding' is set to it. If all fail, 'fileencoding' is set to | 2279 'fileencoding' is set to it. If all fail, 'fileencoding' is set to |
2274 an empty string, which means the value of 'encoding' is used. | 2280 an empty string, which means the value of 'encoding' is used. |
2275 WARNING: Conversion can cause loss of information! When | 2281 WARNING: Conversion can cause loss of information! When |
2276 'encoding' is "utf-8" (or one of the other Unicode variants) | 2282 'encoding' is "utf-8" (or one of the other Unicode variants) |
2277 conversion is most likely done in a way that the reverse | 2283 conversion is most likely done in a way that the reverse |
2278 conversion results in the same text. When 'encoding' is not | 2284 conversion results in the same text. When 'encoding' is not |
2342 starting to edit a new buffer and when reading a file into an existing | 2348 starting to edit a new buffer and when reading a file into an existing |
2343 buffer: | 2349 buffer: |
2344 - When empty, the format defined with 'fileformat' will be used | 2350 - When empty, the format defined with 'fileformat' will be used |
2345 always. It is not set automatically. | 2351 always. It is not set automatically. |
2346 - When set to one name, that format will be used whenever a new buffer | 2352 - When set to one name, that format will be used whenever a new buffer |
2347 is opened. 'fileformat' is set accordingly for that buffer. The | 2353 is opened. 'fileformat' is set accordingly for that buffer. The |
2348 'fileformats' name will be used when a file is read into an existing | 2354 'fileformats' name will be used when a file is read into an existing |
2349 buffer, no matter what 'fileformat' for that buffer is set to. | 2355 buffer, no matter what 'fileformat' for that buffer is set to. |
2350 - When more than one name is present, separated by commas, automatic | 2356 - When more than one name is present, separated by commas, automatic |
2351 <EOL> detection will be done when reading a file. When starting to | 2357 <EOL> detection will be done when reading a file. When starting to |
2352 edit a file, a check is done for the <EOL>: | 2358 edit a file, a check is done for the <EOL>: |
2353 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos", | 2359 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos", |
2354 'fileformat' is set to "dos". | 2360 'fileformat' is set to "dos". |
2355 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat' | 2361 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat' |
2356 is set to "unix". Note that when a <NL> is found without a | 2362 is set to "unix". Note that when a <NL> is found without a |
2357 preceding <CR>, "unix" is preferred over "dos". | 2363 preceding <CR>, "unix" is preferred over "dos". |
2358 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac". | 2364 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac". |
2359 This means that "mac" is only chosen when "unix" is not present, | 2365 This means that "mac" is only chosen when "unix" is not present, |
2360 or when no <NL> is found in the file, and when "dos" is not | 2366 or when no <NL> is found in the file, and when "dos" is not |
2361 present, or no <CR><NL> is present in the file. | 2367 present, or no <CR><NL> is present in the file. |
2422 stlnc:c ' ' or '-' statusline of the non-current windows | 2428 stlnc:c ' ' or '-' statusline of the non-current windows |
2423 vert:c '|' vertical separators |:vsplit| | 2429 vert:c '|' vertical separators |:vsplit| |
2424 fold:c '-' filling 'foldtext' | 2430 fold:c '-' filling 'foldtext' |
2425 diff:c '-' deleted lines of the 'diff' option | 2431 diff:c '-' deleted lines of the 'diff' option |
2426 | 2432 |
2427 Any one that is omitted will fall back to the default. For "stl" and | 2433 Any one that is omitted will fall back to the default. For "stl" and |
2428 "stlnc" the space will be used when there is highlighting, '^' or '-' | 2434 "stlnc" the space will be used when there is highlighting, '^' or '-' |
2429 otherwise. | 2435 otherwise. |
2430 | 2436 |
2431 Example: > | 2437 Example: > |
2432 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:- | 2438 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:- |
2447 {not in Vi} | 2453 {not in Vi} |
2448 {only available when compiled with the |+rightleft| | 2454 {only available when compiled with the |+rightleft| |
2449 feature} | 2455 feature} |
2450 When on, the keyboard is mapped for the Farsi character set. | 2456 When on, the keyboard is mapped for the Farsi character set. |
2451 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to | 2457 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to |
2452 toggle this option |i_CTRL-_|. See |farsi.txt|. | 2458 toggle this option |i_CTRL-_|. See |farsi.txt|. |
2453 | 2459 |
2454 *'foldclose'* *'fcl'* | 2460 *'foldclose'* *'fcl'* |
2455 'foldclose' 'fcl' string (default "") | 2461 'foldclose' 'fcl' string (default "") |
2456 global | 2462 global |
2457 {not in Vi} | 2463 {not in Vi} |
2479 {not available when compiled without the |+folding| | 2485 {not available when compiled without the |+folding| |
2480 feature} | 2486 feature} |
2481 When off, all folds are open. This option can be used to quickly | 2487 When off, all folds are open. This option can be used to quickly |
2482 switch between showing all text unfolded and viewing the text with | 2488 switch between showing all text unfolded and viewing the text with |
2483 folds (including manually opened or closed folds). It can be toggled | 2489 folds (including manually opened or closed folds). It can be toggled |
2484 with the |zi| command. The 'foldcolumn' will remain blank when | 2490 with the |zi| command. The 'foldcolumn' will remain blank when |
2485 'foldenable' is off. | 2491 'foldenable' is off. |
2486 This option is set by commands that create a new fold or close a fold. | 2492 This option is set by commands that create a new fold or close a fold. |
2487 See |folding|. | 2493 See |folding|. |
2488 | 2494 |
2489 *'foldexpr'* *'fde'* | 2495 *'foldexpr'* *'fde'* |
2502 {not in Vi} | 2508 {not in Vi} |
2503 {not available when compiled without the |+folding| | 2509 {not available when compiled without the |+folding| |
2504 feature} | 2510 feature} |
2505 Used only when 'foldmethod' is "indent". Lines starting with | 2511 Used only when 'foldmethod' is "indent". Lines starting with |
2506 characters in 'foldignore' will get their fold level from surrounding | 2512 characters in 'foldignore' will get their fold level from surrounding |
2507 lines. White space is skipped before checking for this character. | 2513 lines. White space is skipped before checking for this character. |
2508 The default "#" works well for C programs. See |fold-indent|. | 2514 The default "#" works well for C programs. See |fold-indent|. |
2509 | 2515 |
2510 *'foldlevel'* *'fdl'* | 2516 *'foldlevel'* *'fdl'* |
2511 'foldlevel' 'fdl' number (default: 0) | 2517 'foldlevel' 'fdl' number (default: 0) |
2512 local to window | 2518 local to window |
2527 feature} | 2533 feature} |
2528 Sets 'foldlevel' when starting to edit another buffer in a window. | 2534 Sets 'foldlevel' when starting to edit another buffer in a window. |
2529 Useful to always start editing with all folds closed (value zero), | 2535 Useful to always start editing with all folds closed (value zero), |
2530 some folds closed (one) or no folds closed (99). | 2536 some folds closed (one) or no folds closed (99). |
2531 This is done before reading any modeline, thus a setting in a modeline | 2537 This is done before reading any modeline, thus a setting in a modeline |
2532 overrules this option. Starting to edit a file for |diff-mode| also | 2538 overrules this option. Starting to edit a file for |diff-mode| also |
2533 ignores this option and closes all folds. | 2539 ignores this option and closes all folds. |
2534 It is also done before BufReadPre autocommands, to allow an autocmd to | 2540 It is also done before BufReadPre autocommands, to allow an autocmd to |
2535 overrule the 'foldlevel' value for specific files. | 2541 overrule the 'foldlevel' value for specific files. |
2536 When the value is negative, it is not used. | 2542 When the value is negative, it is not used. |
2537 | 2543 |
2603 quickfix ":cn", ":crew", ":make", etc. | 2609 quickfix ":cn", ":crew", ":make", etc. |
2604 search search for a pattern: "/", "n", "*", "gd", etc. | 2610 search search for a pattern: "/", "n", "*", "gd", etc. |
2605 (not for a search pattern in a ":" command) | 2611 (not for a search pattern in a ":" command) |
2606 tag jumping to a tag: ":ta", CTRL-T, etc. | 2612 tag jumping to a tag: ":ta", CTRL-T, etc. |
2607 undo undo or redo: "u" and CTRL-R | 2613 undo undo or redo: "u" and CTRL-R |
2608 When the command is part of a mapping this option is not used. Add | 2614 When the command is part of a mapping this option is not used. Add |
2609 the |zv| command to the mapping to get the same effect. | 2615 the |zv| command to the mapping to get the same effect. |
2610 When a movement command is used for an operator (e.g., "dl" or "y%") | 2616 When a movement command is used for an operator (e.g., "dl" or "y%") |
2611 this option is not used. This means the operator will include the | 2617 this option is not used. This means the operator will include the |
2612 whole closed fold. | 2618 whole closed fold. |
2613 Note that vertical movements are not here, because it would make it | 2619 Note that vertical movements are not here, because it would make it |
2713 global | 2719 global |
2714 {not in Vi} | 2720 {not in Vi} |
2715 {only available when compiled with GUI enabled, and | 2721 {only available when compiled with GUI enabled, and |
2716 for MS-DOS and Win32 console} | 2722 for MS-DOS and Win32 console} |
2717 This option tells Vim what the cursor should look like in different | 2723 This option tells Vim what the cursor should look like in different |
2718 modes. It fully works in the GUI. In an MSDOS or Win32 console, only | 2724 modes. It fully works in the GUI. In an MSDOS or Win32 console, only |
2719 the height of the cursor can be changed. This can be done by | 2725 the height of the cursor can be changed. This can be done by |
2720 specifying a block cursor, or a percentage for a vertical or | 2726 specifying a block cursor, or a percentage for a vertical or |
2721 horizontal cursor. | 2727 horizontal cursor. |
2722 | 2728 |
2723 The option is a comma separated list of parts. Each part consist of a | 2729 The option is a comma separated list of parts. Each part consist of a |
2724 mode-list and an argument-list: | 2730 mode-list and an argument-list: |
2725 mode-list:argument-list,mode-list:argument-list,.. | 2731 mode-list:argument-list,mode-list:argument-list,.. |
2726 The mode-list is a dash separated list of these modes: | 2732 The mode-list is a dash separated list of these modes: |
2727 n Normal mode | 2733 n Normal mode |
2728 v Visual mode | 2734 v Visual mode |
2899 GTK+ 2 GUI only: *guifontwide_gtk2* | 2905 GTK+ 2 GUI only: *guifontwide_gtk2* |
2900 | 2906 |
2901 If set and valid, 'guifontwide' is always used for double width | 2907 If set and valid, 'guifontwide' is always used for double width |
2902 characters, even if 'encoding' is not set to "utf-8". | 2908 characters, even if 'encoding' is not set to "utf-8". |
2903 Vim does not attempt to find an appropriate value for 'guifontwide' | 2909 Vim does not attempt to find an appropriate value for 'guifontwide' |
2904 automatically. If 'guifontwide' is empty Pango/Xft will choose the | 2910 automatically. If 'guifontwide' is empty Pango/Xft will choose the |
2905 font for characters not available in 'guifont'. Thus you do not need | 2911 font for characters not available in 'guifont'. Thus you do not need |
2906 to set 'guifontwide' at all unless you want to override the choice | 2912 to set 'guifontwide' at all unless you want to override the choice |
2907 made by Pango/Xft. | 2913 made by Pango/Xft. |
2908 | 2914 |
2909 *'guiheadroom'* *'ghr'* | 2915 *'guiheadroom'* *'ghr'* |
2911 global | 2917 global |
2912 {not in Vi} {only for GTK and X11 GUI} | 2918 {not in Vi} {only for GTK and X11 GUI} |
2913 The number of pixels subtracted from the screen height when fitting | 2919 The number of pixels subtracted from the screen height when fitting |
2914 the GUI window on the screen. Set this before the GUI is started, | 2920 the GUI window on the screen. Set this before the GUI is started, |
2915 e.g., in your |gvimrc| file. When zero, the whole screen height will | 2921 e.g., in your |gvimrc| file. When zero, the whole screen height will |
2916 be used by the window. When positive, the specified number of pixel | 2922 be used by the window. When positive, the specified number of pixel |
2917 lines will be left for window decorations and other items on the | 2923 lines will be left for window decorations and other items on the |
2918 screen. Set it to a negative value to allow windows taller than the | 2924 screen. Set it to a negative value to allow windows taller than the |
2919 screen. | 2925 screen. |
2920 | 2926 |
2921 *'guioptions'* *'go'* | 2927 *'guioptions'* *'go'* |
2945 If not present, then Vim won't become the owner of the | 2951 If not present, then Vim won't become the owner of the |
2946 windowing system's global selection unless explicitly told to | 2952 windowing system's global selection unless explicitly told to |
2947 by a yank or delete operation for the "* register. | 2953 by a yank or delete operation for the "* register. |
2948 The same applies to the modeless selection. | 2954 The same applies to the modeless selection. |
2949 | 2955 |
2950 'A' Autoselect for the modeless selection. Like 'a', but only | 2956 'A' Autoselect for the modeless selection. Like 'a', but only |
2951 applies to the modeless selection. | 2957 applies to the modeless selection. |
2952 | 2958 |
2953 'guioptions' autoselect Visual autoselect modeless ~ | 2959 'guioptions' autoselect Visual autoselect modeless ~ |
2954 "" - - | 2960 "" - - |
2955 "a" yes yes | 2961 "a" yes yes |
2970 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper | 2976 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper |
2971 corner of the window. It's black&white on non-GTK, because of | 2977 corner of the window. It's black&white on non-GTK, because of |
2972 limitations of X11. For a color icon, see |X11-icon|. | 2978 limitations of X11. For a color icon, see |X11-icon|. |
2973 | 2979 |
2974 'm' Menu bar is present. | 2980 'm' Menu bar is present. |
2975 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note | 2981 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note |
2976 that this flag must be added in the .vimrc file, before | 2982 that this flag must be added in the .vimrc file, before |
2977 switching on syntax or filetype recognition (when the .gvimrc | 2983 switching on syntax or filetype recognition (when the .gvimrc |
2978 file is sourced the system menu has already been loaded; the | 2984 file is sourced the system menu has already been loaded; the |
2979 ":syntax on" and ":filetype on" commands load the menu too). | 2985 ":syntax on" and ":filetype on" commands load the menu too). |
2980 'g' Grey menu items: Make menu items that are not active grey. If | 2986 'g' Grey menu items: Make menu items that are not active grey. If |
3007 'p' Use Pointer callbacks for X11 GUI. This is required for some | 3013 'p' Use Pointer callbacks for X11 GUI. This is required for some |
3008 window managers. If the cursor is not blinking or hollow at | 3014 window managers. If the cursor is not blinking or hollow at |
3009 the right moment, try adding this flag. This must be done | 3015 the right moment, try adding this flag. This must be done |
3010 before starting the GUI. Set it in your gvimrc. Adding or | 3016 before starting the GUI. Set it in your gvimrc. Adding or |
3011 removing it after the GUI has started has no effect. | 3017 removing it after the GUI has started has no effect. |
3012 'F' Add a footer. Only for Motif. See |gui-footer|. | 3018 'F' Add a footer. Only for Motif. See |gui-footer|. |
3013 | 3019 |
3014 *'guipty'* *'noguipty'* | 3020 *'guipty'* *'noguipty'* |
3015 'guipty' boolean (default on) | 3021 'guipty' boolean (default on) |
3016 global | 3022 global |
3017 {not in Vi} | 3023 {not in Vi} |
3027 Name of the main help file. All distributed help files should be | 3033 Name of the main help file. All distributed help files should be |
3028 placed together in one directory. Additionally, all "doc" directories | 3034 placed together in one directory. Additionally, all "doc" directories |
3029 in 'runtimepath' will be used. | 3035 in 'runtimepath' will be used. |
3030 Environment variables are expanded |:set_env|. For example: | 3036 Environment variables are expanded |:set_env|. For example: |
3031 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also | 3037 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also |
3032 tried. Also see |$VIMRUNTIME| and |option-backslash| about including | 3038 tried. Also see |$VIMRUNTIME| and |option-backslash| about including |
3033 spaces and backslashes. | 3039 spaces and backslashes. |
3034 This option cannot be set from a |modeline| or in the |sandbox|, for | 3040 This option cannot be set from a |modeline| or in the |sandbox|, for |
3035 security reasons. | 3041 security reasons. |
3036 | 3042 |
3037 *'helpheight'* *'hh'* | 3043 *'helpheight'* *'hh'* |
3073 buffer becomes hidden when it is |abandon|ed. If the buffer is still | 3079 buffer becomes hidden when it is |abandon|ed. If the buffer is still |
3074 displayed in another window, it does not become hidden, of course. | 3080 displayed in another window, it does not become hidden, of course. |
3075 The commands that move through the buffer list sometimes make a buffer | 3081 The commands that move through the buffer list sometimes make a buffer |
3076 hidden although the 'hidden' option is off: When the buffer is | 3082 hidden although the 'hidden' option is off: When the buffer is |
3077 modified, 'autowrite' is off or writing is not possible, and the '!' | 3083 modified, 'autowrite' is off or writing is not possible, and the '!' |
3078 flag was used. See also |windows.txt|. | 3084 flag was used. See also |windows.txt|. |
3079 This option is set for one command with ":hide {command}" |:hide|. | 3085 This option is set for one command with ":hide {command}" |:hide|. |
3080 WARNING: It's easy to forget that you have changes in hidden buffers. | 3086 WARNING: It's easy to forget that you have changes in hidden buffers. |
3081 Think twice when using ":q!" or ":qa!". | 3087 Think twice when using ":q!" or ":qa!". |
3082 | 3088 |
3083 *'highlight'* *'hl'* | 3089 *'highlight'* *'hl'* |
3093 global | 3099 global |
3094 {not in Vi} | 3100 {not in Vi} |
3095 This option can be used to set highlighting mode for various | 3101 This option can be used to set highlighting mode for various |
3096 occasions. It is a comma separated list of character pairs. The | 3102 occasions. It is a comma separated list of character pairs. The |
3097 first character in a pair gives the occasion, the second the mode to | 3103 first character in a pair gives the occasion, the second the mode to |
3098 use for that occasion. The occasions are: | 3104 use for that occasion. The occasions are: |
3099 |hl-SpecialKey| 8 Meta and special keys listed with ":map" | 3105 |hl-SpecialKey| 8 Meta and special keys listed with ":map" |
3100 |hl-NonText| @ '~' and '@' at the end of the window and | 3106 |hl-NonText| @ '~' and '@' at the end of the window and |
3101 characters from 'showbreak' | 3107 characters from 'showbreak' |
3102 |hl-Directory| d directories in CTRL-D listing and other special | 3108 |hl-Directory| d directories in CTRL-D listing and other special |
3103 things in listings | 3109 things in listings |
3156 When you get bored looking at the highlighted matches, you can turn it | 3162 When you get bored looking at the highlighted matches, you can turn it |
3157 off with |:nohlsearch|. As soon as you use a search command, the | 3163 off with |:nohlsearch|. As soon as you use a search command, the |
3158 highlighting comes back. | 3164 highlighting comes back. |
3159 When the search pattern can match an end-of-line, Vim will try to | 3165 When the search pattern can match an end-of-line, Vim will try to |
3160 highlight all of the matched text. However, this depends on where the | 3166 highlight all of the matched text. However, this depends on where the |
3161 search starts. This will be the first line in the window or the first | 3167 search starts. This will be the first line in the window or the first |
3162 line below a closed fold. A match in a previous line which is not | 3168 line below a closed fold. A match in a previous line which is not |
3163 drawn may not continue in an newly drawn line. | 3169 drawn may not continue in an newly drawn line. |
3164 NOTE: This option is reset when 'compatible' is set. | 3170 NOTE: This option is reset when 'compatible' is set. |
3165 | 3171 |
3166 *'history'* *'hi'* | 3172 *'history'* *'hi'* |
3225 (currently only X11 GUI and terminals with a non-empty 't_IS' option). | 3231 (currently only X11 GUI and terminals with a non-empty 't_IS' option). |
3226 Does not work for MS Windows. | 3232 Does not work for MS Windows. |
3227 When Vim was compiled with HAVE_X11 defined, the original icon will be | 3233 When Vim was compiled with HAVE_X11 defined, the original icon will be |
3228 restored if possible |X11|. | 3234 restored if possible |X11|. |
3229 When this option contains printf-style '%' items, they will be | 3235 When this option contains printf-style '%' items, they will be |
3230 expanded according to the rules used for 'statusline'. See | 3236 expanded according to the rules used for 'statusline'. See |
3231 'titlestring' for example settings. | 3237 'titlestring' for example settings. |
3232 {not available when compiled without the |+statusline| feature} | 3238 {not available when compiled without the |+statusline| feature} |
3233 | 3239 |
3234 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'* | 3240 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'* |
3235 'ignorecase' 'ic' boolean (default off) | 3241 'ignorecase' 'ic' boolean (default off) |
3340 'include' 'inc' string (default "^\s*#\s*include") | 3346 'include' 'inc' string (default "^\s*#\s*include") |
3341 global or local to buffer |global-local| | 3347 global or local to buffer |global-local| |
3342 {not in Vi} | 3348 {not in Vi} |
3343 {not available when compiled without the | 3349 {not available when compiled without the |
3344 |+find_in_path| feature} | 3350 |+find_in_path| feature} |
3345 Pattern to be used to find an include command. It is a search | 3351 Pattern to be used to find an include command. It is a search |
3346 pattern, just like for the "/" command (See |pattern|). The default | 3352 pattern, just like for the "/" command (See |pattern|). The default |
3347 value is for C programs. This option is used for the commands "[i", | 3353 value is for C programs. This option is used for the commands "[i", |
3348 "]I", "[d", etc.. The 'isfname' option is used to recognize the file | 3354 "]I", "[d", etc.. The 'isfname' option is used to recognize the file |
3349 name that comes after the matched pattern. See |option-backslash| | 3355 name that comes after the matched pattern. See |option-backslash| |
3350 about including spaces and backslashes. | 3356 about including spaces and backslashes. |
3354 local to buffer | 3360 local to buffer |
3355 {not in Vi} | 3361 {not in Vi} |
3356 {not available when compiled without the | 3362 {not available when compiled without the |
3357 |+find_in_path| or |+eval| feature} | 3363 |+find_in_path| or |+eval| feature} |
3358 Expression to be used to transform the string found with the 'include' | 3364 Expression to be used to transform the string found with the 'include' |
3359 option to a file name. Mostly useful to change "." to "/" for Java: > | 3365 option to a file name. Mostly useful to change "." to "/" for Java: > |
3360 :set includeexpr=substitute(v:fname,'\\.','/','g') | 3366 :set includeexpr=substitute(v:fname,'\\.','/','g') |
3361 < The "v:fname" variable will be set to the file name that was detected. | 3367 < The "v:fname" variable will be set to the file name that was detected. |
3362 Evaluated in the |sandbox|. | 3368 Evaluated in the |sandbox|. |
3363 Also used for the |gf| command if an unmodified file name can't be | 3369 Also used for the |gf| command if an unmodified file name can't be |
3364 found. Allows doing "gf" on the name after an 'include' statement. | 3370 found. Allows doing "gf" on the name after an 'include' statement. |
3365 Also used for |<cfile>|. | 3371 Also used for |<cfile>|. |
3366 | 3372 |
3367 *'incsearch'* *'is'* *'noincsearch'* *'nois'* | 3373 *'incsearch'* *'is'* *'noincsearch'* *'nois'* |
3368 'incsearch' 'is' boolean (default off) | 3374 'incsearch' 'is' boolean (default off) |
3369 global | 3375 global |
3370 {not in Vi} | 3376 {not in Vi} |
3371 {not available when compiled without the | 3377 {not available when compiled without the |
3372 |+extra_search| feature} | 3378 |+extra_search| feature} |
3373 While typing a search command, show immediately where the so far | 3379 While typing a search command, show immediately where the so far |
3374 typed pattern matches. The matched string is highlighted. If the | 3380 typed pattern matches. The matched string is highlighted. If the |
3375 pattern is invalid or not found, nothing is shown. The screen will | 3381 pattern is invalid or not found, nothing is shown. The screen will |
3376 be updated often, this is only useful on fast terminals. Note that | 3382 be updated often, this is only useful on fast terminals. Note that |
3377 the match will be shown, but the cursor is not actually positioned | 3383 the match will be shown, but the cursor is not actually positioned |
3378 there. You still need to finish the search command with <CR> to move | 3384 there. You still need to finish the search command with <CR> to move |
3379 the cursor. The highlighting can be set with the 'i' flag in | 3385 the cursor. The highlighting can be set with the 'i' flag in |
3380 'highlight'. See also: 'hlsearch'. | 3386 'highlight'. See also: 'hlsearch'. |
3381 NOTE: This option is reset when 'compatible' is set. | 3387 NOTE: This option is reset when 'compatible' is set. |
3382 | 3388 |
3383 *'indentexpr'* *'inde'* | 3389 *'indentexpr'* *'inde'* |
3470 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") | 3476 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") |
3471 global | 3477 global |
3472 {not in Vi} | 3478 {not in Vi} |
3473 The characters specified by this option are included in file names and | 3479 The characters specified by this option are included in file names and |
3474 path names. Filenames are used for commands like "gf", "[i" and in | 3480 path names. Filenames are used for commands like "gf", "[i" and in |
3475 the tags file. It is also used for "\f" in a |pattern|. | 3481 the tags file. It is also used for "\f" in a |pattern|. |
3476 Multi-byte characters 256 and above are always included, only the | 3482 Multi-byte characters 256 and above are always included, only the |
3477 characters up to 255 are specified with this option. | 3483 characters up to 255 are specified with this option. |
3478 For UTF-8 the characters 0xa0 to 0xff are included as well. | 3484 For UTF-8 the characters 0xa0 to 0xff are included as well. |
3479 | 3485 |
3480 Note that on systems using a backslash as path separator, Vim tries to | 3486 Note that on systems using a backslash as path separator, Vim tries to |
3484 name character on these systems, but it will on Unix and alikes. The | 3490 name character on these systems, but it will on Unix and alikes. The |
3485 '&' and '^' are not included by default, because these are special for | 3491 '&' and '^' are not included by default, because these are special for |
3486 cmd.exe. | 3492 cmd.exe. |
3487 | 3493 |
3488 The format of this option is a list of parts, separated with commas. | 3494 The format of this option is a list of parts, separated with commas. |
3489 Each part can be a single character number or a range. A range is two | 3495 Each part can be a single character number or a range. A range is two |
3490 character numbers with '-' in between. A character number can be a | 3496 character numbers with '-' in between. A character number can be a |
3491 decimal number between 0 and 255 or the ASCII character itself (does | 3497 decimal number between 0 and 255 or the ASCII character itself (does |
3492 not work for digits). Example: | 3498 not work for digits). Example: |
3493 "_,-,128-140,#-43" (include '_' and '-' and the range | 3499 "_,-,128-140,#-43" (include '_' and '-' and the range |
3494 128 to 140 and '#' to 43) | 3500 128 to 140 and '#' to 43) |
3495 If a part starts with '^', the following character number or range | 3501 If a part starts with '^', the following character number or range |
3522 Identifiers are used in recognizing environment variables and after a | 3528 Identifiers are used in recognizing environment variables and after a |
3523 match of the 'define' option. It is also used for "\i" in a | 3529 match of the 'define' option. It is also used for "\i" in a |
3524 |pattern|. See 'isfname' for a description of the format of this | 3530 |pattern|. See 'isfname' for a description of the format of this |
3525 option. | 3531 option. |
3526 Careful: If you change this option, it might break expanding | 3532 Careful: If you change this option, it might break expanding |
3527 environment variables. E.g., when '/' is included and Vim tries to | 3533 environment variables. E.g., when '/' is included and Vim tries to |
3528 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. | 3534 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. |
3529 | 3535 |
3530 *'iskeyword'* *'isk'* | 3536 *'iskeyword'* *'isk'* |
3531 'iskeyword' 'isk' string (Vim default for MS-DOS and Win32: | 3537 'iskeyword' 'isk' string (Vim default for MS-DOS and Win32: |
3532 "@,48-57,_,128-167,224-235" | 3538 "@,48-57,_,128-167,224-235" |
3533 otherwise: "@,48-57,_,192-255" | 3539 otherwise: "@,48-57,_,192-255" |
3534 Vi default: "@,48-57,_") | 3540 Vi default: "@,48-57,_") |
3535 local to buffer | 3541 local to buffer |
3536 {not in Vi} | 3542 {not in Vi} |
3537 Keywords are used in searching and recognizing with many commands: | 3543 Keywords are used in searching and recognizing with many commands: |
3538 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See | 3544 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See |
3539 'isfname' for a description of the format of this option. For C | 3545 'isfname' for a description of the format of this option. For C |
3540 programs you could use "a-z,A-Z,48-57,_,.,-,>". | 3546 programs you could use "a-z,A-Z,48-57,_,.,-,>". |
3541 For a help file it is set to all non-blank printable characters except | 3547 For a help file it is set to all non-blank printable characters except |
3542 '*', '"' and '|' (so that CTRL-] on a command finds the help for that | 3548 '*', '"' and '|' (so that CTRL-] on a command finds the help for that |
3543 command). | 3549 command). |
3648 global | 3654 global |
3649 {not in Vi} | 3655 {not in Vi} |
3650 {only available when compiled with the |+langmap| | 3656 {only available when compiled with the |+langmap| |
3651 feature} | 3657 feature} |
3652 This option allows switching your keyboard into a special language | 3658 This option allows switching your keyboard into a special language |
3653 mode. When you are typing text in Insert mode the characters are | 3659 mode. When you are typing text in Insert mode the characters are |
3654 inserted directly. When in command mode the 'langmap' option takes | 3660 inserted directly. When in command mode the 'langmap' option takes |
3655 care of translating these special characters to the original meaning | 3661 care of translating these special characters to the original meaning |
3656 of the key. This means you don't have to change the keyboard mode to | 3662 of the key. This means you don't have to change the keyboard mode to |
3657 be able to execute Normal mode commands. | 3663 be able to execute Normal mode commands. |
3658 This is the opposite of the 'keymap' option, where characters are | 3664 This is the opposite of the 'keymap' option, where characters are |
3728 'lazyredraw' 'lz' boolean (default off) | 3734 'lazyredraw' 'lz' boolean (default off) |
3729 global | 3735 global |
3730 {not in Vi} | 3736 {not in Vi} |
3731 When this option is set, the screen will not be redrawn while | 3737 When this option is set, the screen will not be redrawn while |
3732 executing macros, registers and other commands that have not been | 3738 executing macros, registers and other commands that have not been |
3733 typed. Also, updating the window title is postponed. To force an | 3739 typed. Also, updating the window title is postponed. To force an |
3734 update use |:redraw|. | 3740 update use |:redraw|. |
3735 | 3741 |
3736 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'* | 3742 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'* |
3737 'linebreak' 'lbr' boolean (default off) | 3743 'linebreak' 'lbr' boolean (default off) |
3738 local to window | 3744 local to window |
3809 | 3815 |
3810 *'listchars'* *'lcs'* | 3816 *'listchars'* *'lcs'* |
3811 'listchars' 'lcs' string (default "eol:$") | 3817 'listchars' 'lcs' string (default "eol:$") |
3812 global | 3818 global |
3813 {not in Vi} | 3819 {not in Vi} |
3814 Strings to use in 'list' mode. It is a comma separated list of string | 3820 Strings to use in 'list' mode. It is a comma separated list of string |
3815 settings. | 3821 settings. |
3816 eol:c Character to show at the end of each line. When | 3822 eol:c Character to show at the end of each line. When |
3817 omitted, there is no extra character at the end of the | 3823 omitted, there is no extra character at the end of the |
3818 line. | 3824 line. |
3819 tab:xy Two characters to be used to show a Tab. The first | 3825 tab:xy Two characters to be used to show a Tab. The first |
3820 char is used once. The second char is repeated to | 3826 char is used once. The second char is repeated to |
3821 fill the space that the Tab normally occupies. | 3827 fill the space that the Tab normally occupies. |
3822 "tab:>-" will show a Tab that takes four spaces as | 3828 "tab:>-" will show a Tab that takes four spaces as |
3823 ">---". When omitted, a Tab is show as ^I. | 3829 ">---". When omitted, a Tab is show as ^I. |
3824 trail:c Character to show for trailing spaces. When omitted, | 3830 trail:c Character to show for trailing spaces. When omitted, |
3825 trailing spaces are blank. | 3831 trailing spaces are blank. |
3826 extends:c Character to show in the last column, when 'wrap' is | 3832 extends:c Character to show in the last column, when 'wrap' is |
3827 off and the line continues beyond the right of the | 3833 off and the line continues beyond the right of the |
3828 screen. | 3834 screen. |
3829 precedes:c Character to show in the first column, when 'wrap' | 3835 precedes:c Character to show in the first column, when 'wrap' |
3830 is off and there is text preceding the character | 3836 is off and there is text preceding the character |
3831 visible in the first column. | 3837 visible in the first column. |
3832 | 3838 |
3833 The characters ':' and ',' should not be used. UTF-8 characters can | 3839 The characters ':' and ',' should not be used. UTF-8 characters can |
3834 be used when 'encoding' is "utf-8", otherwise only printable | 3840 be used when 'encoding' is "utf-8", otherwise only printable |
3835 characters are allowed. | 3841 characters are allowed. |
3836 | 3842 |
3837 Examples: > | 3843 Examples: > |
3838 :set lcs=tab:>-,trail:- | 3844 :set lcs=tab:>-,trail:- |
3900 *'matchpairs'* *'mps'* | 3906 *'matchpairs'* *'mps'* |
3901 'matchpairs' 'mps' string (default "(:),{:},[:]") | 3907 'matchpairs' 'mps' string (default "(:),{:},[:]") |
3902 local to buffer | 3908 local to buffer |
3903 {not in Vi} | 3909 {not in Vi} |
3904 Characters that form pairs. The |%| command jumps from one to the | 3910 Characters that form pairs. The |%| command jumps from one to the |
3905 other. Currently only single character pairs are allowed, and they | 3911 other. Currently only single character pairs are allowed, and they |
3906 must be different. The characters must be separated by a colon. The | 3912 must be different. The characters must be separated by a colon. The |
3907 pairs must be separated by a comma. Example for including '<' and '>' | 3913 pairs must be separated by a comma. Example for including '<' and '>' |
3908 (HTML): > | 3914 (HTML): > |
3909 :set mps+=<:> | 3915 :set mps+=<:> |
3910 | 3916 |
3959 dependent) or half the amount of memory | 3965 dependent) or half the amount of memory |
3960 available) | 3966 available) |
3961 global | 3967 global |
3962 {not in Vi} | 3968 {not in Vi} |
3963 Maximum amount of memory (in Kbyte) to use for all buffers together. | 3969 Maximum amount of memory (in Kbyte) to use for all buffers together. |
3964 Maximum value 2000000. Use this to work without a limit. Also see | 3970 Maximum value 2000000. Use this to work without a limit. Also see |
3965 'maxmem'. | 3971 'maxmem'. |
3966 | 3972 |
3967 *'menuitems'* *'mis'* | 3973 *'menuitems'* *'mis'* |
3968 'menuitems' 'mis' number (default 25) | 3974 'menuitems' 'mis' number (default 25) |
3969 global | 3975 global |
4046 modeless selection. This doesn't move the text cursor. | 4052 modeless selection. This doesn't move the text cursor. |
4047 | 4053 |
4048 See |mouse-using|. Also see |'clipboard'|. | 4054 See |mouse-using|. Also see |'clipboard'|. |
4049 | 4055 |
4050 Note: When enabling the mouse in a terminal, copy/paste will use the | 4056 Note: When enabling the mouse in a terminal, copy/paste will use the |
4051 "* register if there is access to an X-server. The xterm handling of | 4057 "* register if there is access to an X-server. The xterm handling of |
4052 the mouse buttons can still be used by keeping the shift key pressed. | 4058 the mouse buttons can still be used by keeping the shift key pressed. |
4053 Also see the 'clipboard' option. | 4059 Also see the 'clipboard' option. |
4054 | 4060 |
4055 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* | 4061 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* |
4056 'mousefocus' 'mousef' boolean (default off) | 4062 'mousefocus' 'mousef' boolean (default off) |
4233 | 4239 |
4234 *'paste'* *'nopaste'* | 4240 *'paste'* *'nopaste'* |
4235 'paste' boolean (default off) | 4241 'paste' boolean (default off) |
4236 global | 4242 global |
4237 {not in Vi} | 4243 {not in Vi} |
4238 Put Vim in Paste mode. This is useful if you want to cut or copy | 4244 Put Vim in Paste mode. This is useful if you want to cut or copy |
4239 some text from one window and paste it in Vim. This will avoid | 4245 some text from one window and paste it in Vim. This will avoid |
4240 unexpected effects. | 4246 unexpected effects. |
4241 Setting this option is useful when using Vim in a terminal, where Vim | 4247 Setting this option is useful when using Vim in a terminal, where Vim |
4242 cannot distinguish between typed text and pasted text. In the GUI, Vim | 4248 cannot distinguish between typed text and pasted text. In the GUI, Vim |
4243 knows about pasting and will mostly do the right thing without 'paste' | 4249 knows about pasting and will mostly do the right thing without 'paste' |
4244 being set. The same is true for a terminal where Vim handles the | 4250 being set. The same is true for a terminal where Vim handles the |
4245 mouse clicks itself. | 4251 mouse clicks itself. |
4246 When the 'paste' option is switched on (also when it was already on): | 4252 When the 'paste' option is switched on (also when it was already on): |
4247 - mapping in Insert mode and Command-line mode is disabled | 4253 - mapping in Insert mode and Command-line mode is disabled |
4298 global | 4304 global |
4299 {not in Vi} | 4305 {not in Vi} |
4300 {not available when compiled without the |+diff| | 4306 {not available when compiled without the |+diff| |
4301 feature} | 4307 feature} |
4302 Expression which is evaluated to apply a patch to a file and generate | 4308 Expression which is evaluated to apply a patch to a file and generate |
4303 the resulting new version of the file. See |diff-patchexpr|. | 4309 the resulting new version of the file. See |diff-patchexpr|. |
4304 | 4310 |
4305 *'patchmode'* *'pm'* *E206* | 4311 *'patchmode'* *'pm'* *E206* |
4306 'patchmode' 'pm' string (default "") | 4312 'patchmode' 'pm' string (default "") |
4307 global | 4313 global |
4308 {not in Vi} | 4314 {not in Vi} |
4368 :set path=.,c:\\include | 4374 :set path=.,c:\\include |
4369 < Or just use '/' instead: > | 4375 < Or just use '/' instead: > |
4370 :set path=.,c:/include | 4376 :set path=.,c:/include |
4371 < Don't forget "." or files won't even be found in the same directory as | 4377 < Don't forget "." or files won't even be found in the same directory as |
4372 the file! | 4378 the file! |
4373 The maximum length is limited. How much depends on the system, mostly | 4379 The maximum length is limited. How much depends on the system, mostly |
4374 it is something like 256 or 1024 characters. | 4380 it is something like 256 or 1024 characters. |
4375 You can check if all the include files are found, using the value of | 4381 You can check if all the include files are found, using the value of |
4376 'path', see |:checkpath|. | 4382 'path', see |:checkpath|. |
4377 The use of |:set+=| and |:set-=| is preferred when adding or removing | 4383 The use of |:set+=| and |:set-=| is preferred when adding or removing |
4378 directories from the list. This avoids problems when a future version | 4384 directories from the list. This avoids problems when a future version |
4417 'previewwindow' 'pvw' boolean (default off) | 4423 'previewwindow' 'pvw' boolean (default off) |
4418 local to window | 4424 local to window |
4419 {not in Vi} | 4425 {not in Vi} |
4420 {not available when compiled without the |+windows| or | 4426 {not available when compiled without the |+windows| or |
4421 |+quickfix| feature} | 4427 |+quickfix| feature} |
4422 Identifies the preview window. Only one window can have this option | 4428 Identifies the preview window. Only one window can have this option |
4423 set. It's normally not set directly, but by using one of the commands | 4429 set. It's normally not set directly, but by using one of the commands |
4424 |:ptag|, |:pedit|, etc. | 4430 |:ptag|, |:pedit|, etc. |
4425 | 4431 |
4426 *'printdevice'* *'pdev'* | 4432 *'printdevice'* *'pdev'* |
4427 'printdevice' 'pdev' string (default empty) | 4433 'printdevice' 'pdev' string (default empty) |
4731 global | 4737 global |
4732 {not in Vi} | 4738 {not in Vi} |
4733 {not available when compiled without the | 4739 {not available when compiled without the |
4734 |+cmdline_info| feature} | 4740 |+cmdline_info| feature} |
4735 Show the line and column number of the cursor position, separated by a | 4741 Show the line and column number of the cursor position, separated by a |
4736 comma. When there is room, the relative position of the displayed | 4742 comma. When there is room, the relative position of the displayed |
4737 text in the file is shown on the far right: | 4743 text in the file is shown on the far right: |
4738 Top first line is visible | 4744 Top first line is visible |
4739 Bot last line is visible | 4745 Bot last line is visible |
4740 All first and last line are visible | 4746 All first and last line are visible |
4741 45% relative position in the file | 4747 45% relative position in the file |
4742 If 'rulerformat' is set, it will determine the contents of the ruler. | 4748 If 'rulerformat' is set, it will determine the contents of the ruler. |
4743 Each window has its own ruler. If a window has a status line, the | 4749 Each window has its own ruler. If a window has a status line, the |
4744 ruler is shown there. Otherwise it is shown in the last line of the | 4750 ruler is shown there. Otherwise it is shown in the last line of the |
4745 screen. If the statusline is given by 'statusline' (ie. not empty), | 4751 screen. If the statusline is given by 'statusline' (ie. not empty), |
4746 this option takes precedence over 'ruler' and 'rulerformat' | 4752 this option takes precedence over 'ruler' and 'rulerformat' |
4747 If the number of characters displayed is different from the number of | 4753 If the number of characters displayed is different from the number of |
4748 bytes in the text (e.g., for a TAB or a multi-byte character), both | 4754 bytes in the text (e.g., for a TAB or a multi-byte character), both |
4831 personal preferences to overrule or add to the distributed defaults | 4837 personal preferences to overrule or add to the distributed defaults |
4832 or system-wide settings (rarely needed). | 4838 or system-wide settings (rarely needed). |
4833 | 4839 |
4834 Note that, unlike 'path', no wildcards like "**" are allowed. Normal | 4840 Note that, unlike 'path', no wildcards like "**" are allowed. Normal |
4835 wildcards are allowed, but can significantly slow down searching for | 4841 wildcards are allowed, but can significantly slow down searching for |
4836 runtime files. For speed, use as few items as possible and avoid | 4842 runtime files. For speed, use as few items as possible and avoid |
4837 wildcards. | 4843 wildcards. |
4838 See |:runtime|. | 4844 See |:runtime|. |
4839 Example: > | 4845 Example: > |
4840 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME | 4846 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME |
4841 < This will use the directory "~/vimruntime" first (containing your | 4847 < This will use the directory "~/vimruntime" first (containing your |
4854 'scroll' 'scr' number (default: half the window height) | 4860 'scroll' 'scr' number (default: half the window height) |
4855 local to window | 4861 local to window |
4856 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be | 4862 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be |
4857 set to half the number of lines in the window when the window size | 4863 set to half the number of lines in the window when the window size |
4858 changes. If you give a count to the CTRL-U or CTRL-D command it will | 4864 changes. If you give a count to the CTRL-U or CTRL-D command it will |
4859 be used as the new value for 'scroll'. Reset to half the window | 4865 be used as the new value for 'scroll'. Reset to half the window |
4860 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives | 4866 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives |
4861 the number of screen lines instead of file lines, makes a difference | 4867 the number of screen lines instead of file lines, makes a difference |
4862 when lines wrap} | 4868 when lines wrap} |
4863 | 4869 |
4864 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* | 4870 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* |
4943 When on, ":autocmd", shell and write commands are not allowed in | 4949 When on, ":autocmd", shell and write commands are not allowed in |
4944 ".vimrc" and ".exrc" in the current directory and map commands are | 4950 ".vimrc" and ".exrc" in the current directory and map commands are |
4945 displayed. Switch it off only if you know that you will not run into | 4951 displayed. Switch it off only if you know that you will not run into |
4946 problems, or when the 'exrc' option is off. On Unix this option is | 4952 problems, or when the 'exrc' option is off. On Unix this option is |
4947 only used if the ".vimrc" or ".exrc" is not owned by you. This can be | 4953 only used if the ".vimrc" or ".exrc" is not owned by you. This can be |
4948 dangerous if the systems allows users to do a "chown". You better set | 4954 dangerous if the systems allows users to do a "chown". You better set |
4949 'secure' at the end of your ~/.vimrc then. | 4955 'secure' at the end of your ~/.vimrc then. |
4950 This option cannot be set from a |modeline| or in the |sandbox|, for | 4956 This option cannot be set from a |modeline| or in the |sandbox|, for |
4951 security reasons. | 4957 security reasons. |
4952 | 4958 |
4953 *'selection'* *'sel'* | 4959 *'selection'* *'sel'* |
5033 "cmd.exe", OS/2: "cmd") | 5039 "cmd.exe", OS/2: "cmd") |
5034 global | 5040 global |
5035 Name of the shell to use for ! and :! commands. When changing the | 5041 Name of the shell to use for ! and :! commands. When changing the |
5036 value also check these options: 'shelltype', 'shellpipe', 'shellslash' | 5042 value also check these options: 'shelltype', 'shellpipe', 'shellslash' |
5037 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. | 5043 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. |
5038 It is allowed to give an argument to the command, e.g. "csh -f". | 5044 It is allowed to give an argument to the command, e.g. "csh -f". |
5039 See |option-backslash| about including spaces and backslashes. | 5045 See |option-backslash| about including spaces and backslashes. |
5040 Environment variables are expanded |:set_env|. | 5046 Environment variables are expanded |:set_env|. |
5041 If the name of the shell contains a space, you might need to enclose | 5047 If the name of the shell contains a space, you might need to enclose |
5042 it in quotes. Example: > | 5048 it in quotes. Example: > |
5043 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f | 5049 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f |
5044 < Note the backslash before each quote (to avoid starting a comment) and | 5050 < Note the backslash before each quote (to avoid starting a comment) and |
5045 each space (to avoid ending the option value). Also note that the | 5051 each space (to avoid ending the option value). Also note that the |
5046 "-f" is not inside the quotes, because it is not part of the command | 5052 "-f" is not inside the quotes, because it is not part of the command |
5047 name. And Vim automagically recognizes the backslashes that are path | 5053 name. And Vim automagically recognizes the backslashes that are path |
5048 separators. | 5054 separators. |
5049 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment | 5055 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment |
5050 variable to change the way external commands are executed. See the | 5056 variable to change the way external commands are executed. See the |
5078 global | 5084 global |
5079 {not in Vi} | 5085 {not in Vi} |
5080 {not available when compiled without the |+quickfix| | 5086 {not available when compiled without the |+quickfix| |
5081 feature} | 5087 feature} |
5082 String to be used to put the output of the ":make" command in the | 5088 String to be used to put the output of the ":make" command in the |
5083 error file. See also |:make_makeprg|. See |option-backslash| about | 5089 error file. See also |:make_makeprg|. See |option-backslash| about |
5084 including spaces and backslashes. | 5090 including spaces and backslashes. |
5085 The name of the temporary file can be represented by "%s" if necessary | 5091 The name of the temporary file can be represented by "%s" if necessary |
5086 (the file name is appended automatically if no %s appears in the value | 5092 (the file name is appended automatically if no %s appears in the value |
5087 of this option). | 5093 of this option). |
5088 For the Amiga and MS-DOS the default is ">". The output is directly | 5094 For the Amiga and MS-DOS the default is ">". The output is directly |
5207 NOTE: This option is reset when 'compatible' is set. | 5213 NOTE: This option is reset when 'compatible' is set. |
5208 | 5214 |
5209 *'shiftwidth'* *'sw'* | 5215 *'shiftwidth'* *'sw'* |
5210 'shiftwidth' 'sw' number (default 8) | 5216 'shiftwidth' 'sw' number (default 8) |
5211 local to buffer | 5217 local to buffer |
5212 Number of spaces to use for each step of (auto)indent. Used for | 5218 Number of spaces to use for each step of (auto)indent. Used for |
5213 |'cindent'|, |>>|, |<<|, etc. | 5219 |'cindent'|, |>>|, |<<|, etc. |
5214 | 5220 |
5215 *'shortmess'* *'shm'* | 5221 *'shortmess'* *'shm'* |
5216 'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "") | 5222 'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "") |
5217 global | 5223 global |
5296 off) | 5302 off) |
5297 global | 5303 global |
5298 {not in Vi} | 5304 {not in Vi} |
5299 {not available when compiled without the | 5305 {not available when compiled without the |
5300 |+cmdline_info| feature} | 5306 |+cmdline_info| feature} |
5301 Show (partial) command in status line. Set this option off if your | 5307 Show (partial) command in status line. Set this option off if your |
5302 terminal is slow. | 5308 terminal is slow. |
5303 In Visual mode the size of the selected area is shown: | 5309 In Visual mode the size of the selected area is shown: |
5304 - When selecting characters within a line, the number of characters. | 5310 - When selecting characters within a line, the number of characters. |
5305 - When selecting more than one line, the number of lines. | 5311 - When selecting more than one line, the number of lines. |
5306 - When selecting a block, the size in screen characters: linesxcolumns. | 5312 - When selecting a block, the size in screen characters: linesxcolumns. |
5311 'showfulltag' 'sft' boolean (default off) | 5317 'showfulltag' 'sft' boolean (default off) |
5312 global | 5318 global |
5313 {not in Vi} | 5319 {not in Vi} |
5314 When completing a word in insert mode (see |ins-completion|) from the | 5320 When completing a word in insert mode (see |ins-completion|) from the |
5315 tags file, show both the tag name and a tidied-up form of the search | 5321 tags file, show both the tag name and a tidied-up form of the search |
5316 pattern (if there is one) as possible matches. Thus, if you have | 5322 pattern (if there is one) as possible matches. Thus, if you have |
5317 matched a C function, you can see a template for what arguments are | 5323 matched a C function, you can see a template for what arguments are |
5318 required (coding style permitting). | 5324 required (coding style permitting). |
5319 | 5325 |
5320 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* | 5326 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* |
5321 'showmatch' 'sm' boolean (default off) | 5327 'showmatch' 'sm' boolean (default off) |
5338 'showmode' 'smd' boolean (Vim default: on, Vi default: off) | 5344 'showmode' 'smd' boolean (Vim default: on, Vi default: off) |
5339 global | 5345 global |
5340 If in Insert, Replace or Visual mode put a message on the last line. | 5346 If in Insert, Replace or Visual mode put a message on the last line. |
5341 Use the 'M' flag in 'highlight' to set the type of highlighting for | 5347 Use the 'M' flag in 'highlight' to set the type of highlighting for |
5342 this message. | 5348 this message. |
5343 When |XIM| may be used the message will include "XIM". But this | 5349 When |XIM| may be used the message will include "XIM". But this |
5344 doesn't mean XIM is really active, especially when 'imactivatekey' is | 5350 doesn't mean XIM is really active, especially when 'imactivatekey' is |
5345 not set. | 5351 not set. |
5346 NOTE: This option is set to the Vi default value when 'compatible' is | 5352 NOTE: This option is set to the Vi default value when 'compatible' is |
5347 set and to the Vim default value when 'compatible' is reset. | 5353 set and to the Vim default value when 'compatible' is reset. |
5348 | 5354 |
5384 global | 5390 global |
5385 {not in Vi} | 5391 {not in Vi} |
5386 Override the 'ignorecase' option if the search pattern contains upper | 5392 Override the 'ignorecase' option if the search pattern contains upper |
5387 case characters. Only used when the search pattern is typed and | 5393 case characters. Only used when the search pattern is typed and |
5388 'ignorecase' option is on. Used for the commands "/", "?", "n", "N", | 5394 'ignorecase' option is on. Used for the commands "/", "?", "n", "N", |
5389 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After | 5395 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After |
5390 "*" and "#" you can make 'smartcase' used by doing a "/" command, | 5396 "*" and "#" you can make 'smartcase' used by doing a "/" command, |
5391 recalling the search pattern from history and hitting <Enter>. | 5397 recalling the search pattern from history and hitting <Enter>. |
5392 NOTE: This option is reset when 'compatible' is set. | 5398 NOTE: This option is reset when 'compatible' is set. |
5393 | 5399 |
5394 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* | 5400 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* |
5409 - Before a line starting with '}' (only with the "O" command). | 5415 - Before a line starting with '}' (only with the "O" command). |
5410 When typing '}' as the first character in a new line, that line is | 5416 When typing '}' as the first character in a new line, that line is |
5411 given the same indent as the matching '{'. | 5417 given the same indent as the matching '{'. |
5412 When typing '#' as the first character in a new line, the indent for | 5418 When typing '#' as the first character in a new line, the indent for |
5413 that line is removed, the '#' is put in the first column. The indent | 5419 that line is removed, the '#' is put in the first column. The indent |
5414 is restored for the next line. If you don't want this, use this | 5420 is restored for the next line. If you don't want this, use this |
5415 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. | 5421 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. |
5416 When using the ">>" command, lines starting with '#' are not shifted | 5422 When using the ">>" command, lines starting with '#' are not shifted |
5417 right. | 5423 right. |
5418 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste' | 5424 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste' |
5419 is set smart indenting is disabled. | 5425 is set smart indenting is disabled. |
5420 | 5426 |
5421 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* | 5427 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* |
5422 'smarttab' 'sta' boolean (default off) | 5428 'smarttab' 'sta' boolean (default off) |
5423 global | 5429 global |
5473 'startofline' 'sol' boolean (default on) | 5479 'startofline' 'sol' boolean (default on) |
5474 global | 5480 global |
5475 {not in Vi} | 5481 {not in Vi} |
5476 When "on" the commands listed below move the cursor to the first | 5482 When "on" the commands listed below move the cursor to the first |
5477 blank of the line. When off the cursor is kept in the same column | 5483 blank of the line. When off the cursor is kept in the same column |
5478 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B, | 5484 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B, |
5479 CTRL-F, "G", "H", "M", "L", , and to the commands "d", "<<" and ">>" | 5485 CTRL-F, "G", "H", "M", "L", , and to the commands "d", "<<" and ">>" |
5480 with a linewise operator, with "%" with a count and to buffer changing | 5486 with a linewise operator, with "%" with a count and to buffer changing |
5481 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that | 5487 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that |
5482 only has a line number, e.g., ":25" or ":+". | 5488 only has a line number, e.g., ":25" or ":+". |
5483 In case of buffer changing commands the cursor is placed at the column | 5489 In case of buffer changing commands the cursor is placed at the column |
5506 - Left justify the item. The default is right justified | 5512 - Left justify the item. The default is right justified |
5507 when minwid is larger than the length of the item. | 5513 when minwid is larger than the length of the item. |
5508 0 Leading zeroes in numeric items. Overridden by '-'. | 5514 0 Leading zeroes in numeric items. Overridden by '-'. |
5509 minwid Minimum width of the item, padding as set by '-' & '0'. | 5515 minwid Minimum width of the item, padding as set by '-' & '0'. |
5510 Value must be 50 or less. | 5516 Value must be 50 or less. |
5511 maxwid Maximum width of the item. Truncation occurs with a '<' | 5517 maxwid Maximum width of the item. Truncation occurs with a '<' |
5512 on the left for text items. Numeric items will be | 5518 on the left for text items. Numeric items will be |
5513 shifted down to maxwid-2 digits followed by '>'number | 5519 shifted down to maxwid-2 digits followed by '>'number |
5514 where number is the amount of missing digits, much like | 5520 where number is the amount of missing digits, much like |
5515 an exponential notation. | 5521 an exponential notation. |
5516 item A one letter code as described below. | 5522 item A one letter code as described below. |
5549 N N Printer page number. (Only works in the 'printheader' option.) | 5555 N N Printer page number. (Only works in the 'printheader' option.) |
5550 l N Line number. | 5556 l N Line number. |
5551 L N Number of lines in buffer. | 5557 L N Number of lines in buffer. |
5552 c N Column number. | 5558 c N Column number. |
5553 v N Virtual column number. | 5559 v N Virtual column number. |
5554 V N Virtual column number as -{num}. Not displayed if equal to 'c'. | 5560 V N Virtual column number as -{num}. Not displayed if equal to 'c'. |
5555 p N Percentage through file in lines as in |CTRL-G|. | 5561 p N Percentage through file in lines as in |CTRL-G|. |
5556 P S Percentage through file of displayed window. This is like the | 5562 P S Percentage through file of displayed window. This is like the |
5557 percentage described for 'ruler'. Always 3 in length. | 5563 percentage described for 'ruler'. Always 3 in length. |
5558 a S Argument list status as in default title. ({current} of {max}) | 5564 a S Argument list status as in default title. ({current} of {max}) |
5559 Empty if the argument file count is zero or one. | 5565 Empty if the argument file count is zero or one. |
5571 to StatusLineNC for the statusline of non-current windows. | 5577 to StatusLineNC for the statusline of non-current windows. |
5572 The number N must be between 1 and 9. See |hl-User1..9| | 5578 The number N must be between 1 and 9. See |hl-User1..9| |
5573 | 5579 |
5574 Display of flags are controlled by the following heuristic: | 5580 Display of flags are controlled by the following heuristic: |
5575 If a flag text starts with comma it is assumed that it wants to | 5581 If a flag text starts with comma it is assumed that it wants to |
5576 separate itself from anything but preceding plaintext. If it starts | 5582 separate itself from anything but preceding plaintext. If it starts |
5577 with a space it is assumed that it wants to separate itself from | 5583 with a space it is assumed that it wants to separate itself from |
5578 anything but other flags. That is: A leading comma is removed if the | 5584 anything but other flags. That is: A leading comma is removed if the |
5579 preceding character stems from plaintext. A leading space is removed | 5585 preceding character stems from plaintext. A leading space is removed |
5580 if the preceding character stems from another active flag. This will | 5586 if the preceding character stems from another active flag. This will |
5581 make a nice display when flags are used like in the examples below. | 5587 make a nice display when flags are used like in the examples below. |
5629 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") | 5635 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") |
5630 global | 5636 global |
5631 {not in Vi} | 5637 {not in Vi} |
5632 Files with these suffixes get a lower priority when multiple files | 5638 Files with these suffixes get a lower priority when multiple files |
5633 match a wildcard. See |suffixes|. Commas can be used to separate the | 5639 match a wildcard. See |suffixes|. Commas can be used to separate the |
5634 suffixes. Spaces after the comma are ignored. A dot is also seen as | 5640 suffixes. Spaces after the comma are ignored. A dot is also seen as |
5635 the start of a suffix. To avoid a dot or comma being recognized as a | 5641 the start of a suffix. To avoid a dot or comma being recognized as a |
5636 separator, precede it with a backslash (see |option-backslash| about | 5642 separator, precede it with a backslash (see |option-backslash| about |
5637 including spaces and backslashes). | 5643 including spaces and backslashes). |
5638 See 'wildignore' for completely ignoring files. | 5644 See 'wildignore' for completely ignoring files. |
5639 The use of |:set+=| and |:set-=| is preferred when adding or removing | 5645 The use of |:set+=| and |:set-=| is preferred when adding or removing |
5640 suffixes from the list. This avoids problems when a future version | 5646 suffixes from the list. This avoids problems when a future version |
5652 < | 5658 < |
5653 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* | 5659 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* |
5654 'swapfile' 'swf' boolean (default on) | 5660 'swapfile' 'swf' boolean (default on) |
5655 local to buffer | 5661 local to buffer |
5656 {not in Vi} | 5662 {not in Vi} |
5657 Use a swapfile for the buffer. This option can be reset when a | 5663 Use a swapfile for the buffer. This option can be reset when a |
5658 swapfile is not wanted for a specific buffer. For example, with | 5664 swapfile is not wanted for a specific buffer. For example, with |
5659 confidential information that even root must not be able to access. | 5665 confidential information that even root must not be able to access. |
5660 Careful: All text will be in memory: | 5666 Careful: All text will be in memory: |
5661 - Don't use this for big files. | 5667 - Don't use this for big files. |
5662 - Recovery will be impossible! | 5668 - Recovery will be impossible! |
5673 *'swapsync'* *'sws'* | 5679 *'swapsync'* *'sws'* |
5674 'swapsync' 'sws' string (default "fsync") | 5680 'swapsync' 'sws' string (default "fsync") |
5675 global | 5681 global |
5676 {not in Vi} | 5682 {not in Vi} |
5677 When this option is not empty a swap file is synced to disk after | 5683 When this option is not empty a swap file is synced to disk after |
5678 writing to it. This takes some time, especially on busy unix systems. | 5684 writing to it. This takes some time, especially on busy unix systems. |
5679 When this option is empty parts of the swap file may be in memory and | 5685 When this option is empty parts of the swap file may be in memory and |
5680 not written to disk. When the system crashes you may lose more work. | 5686 not written to disk. When the system crashes you may lose more work. |
5681 On Unix the system does a sync now and then without Vim asking for it, | 5687 On Unix the system does a sync now and then without Vim asking for it, |
5682 so the disadvantage of setting this option off is small. On some | 5688 so the disadvantage of setting this option off is small. On some |
5683 systems the swap file will not be written at all. For a unix system | 5689 systems the swap file will not be written at all. For a unix system |
5740 behave like a tab appears every 4 (or 3) characters. | 5746 behave like a tab appears every 4 (or 3) characters. |
5741 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use | 5747 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use |
5742 'expandtab'. This way you will always insert spaces. The | 5748 'expandtab'. This way you will always insert spaces. The |
5743 formatting will never be messed up when 'tabstop' is changed. | 5749 formatting will never be messed up when 'tabstop' is changed. |
5744 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a | 5750 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a |
5745 |modeline| to set these values when editing the file again. Only | 5751 |modeline| to set these values when editing the file again. Only |
5746 works when using Vim to edit the file. | 5752 works when using Vim to edit the file. |
5747 4. Always set 'tabstop' and 'shiftwidth' to the same value, and | 5753 4. Always set 'tabstop' and 'shiftwidth' to the same value, and |
5748 'noexpandtab'. This should then work (for initial indents only) | 5754 'noexpandtab'. This should then work (for initial indents only) |
5749 for any tabstop setting that people use. It might be nice to have | 5755 for any tabstop setting that people use. It might be nice to have |
5750 tabs after the first non-blank inserted as spaces if you do this | 5756 tabs after the first non-blank inserted as spaces if you do this |
5754 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'* | 5760 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'* |
5755 'tagbsearch' 'tbs' boolean (default on) | 5761 'tagbsearch' 'tbs' boolean (default on) |
5756 global | 5762 global |
5757 {not in Vi} | 5763 {not in Vi} |
5758 When searching for a tag (e.g., for the |:ta| command), Vim can either | 5764 When searching for a tag (e.g., for the |:ta| command), Vim can either |
5759 use a binary search or a linear search in a tags file. Binary | 5765 use a binary search or a linear search in a tags file. Binary |
5760 searching makes searching for a tag a LOT faster, but a linear search | 5766 searching makes searching for a tag a LOT faster, but a linear search |
5761 will find more tags if the tags file wasn't properly sorted. | 5767 will find more tags if the tags file wasn't properly sorted. |
5762 Vim normally assumes that your tags files are sorted, or indicate that | 5768 Vim normally assumes that your tags files are sorted, or indicate that |
5763 they are not sorted. Only when this is not the case does the | 5769 they are not sorted. Only when this is not the case does the |
5764 'tagbsearch' option need to be switched off. | 5770 'tagbsearch' option need to be switched off. |
5765 | 5771 |
5766 When 'tagbsearch' is on, binary searching is first used in the tags | 5772 When 'tagbsearch' is on, binary searching is first used in the tags |
5767 files. In certain situations, Vim will do a linear search instead for | 5773 files. In certain situations, Vim will do a linear search instead for |
5768 certain files, or retry all files with a linear search. When | 5774 certain files, or retry all files with a linear search. When |
5769 'tagbsearch' is off, only a linear search is done. | 5775 'tagbsearch' is off, only a linear search is done. |
5770 | 5776 |
5771 Linear searching is done anyway, for one file, when Vim finds a line | 5777 Linear searching is done anyway, for one file, when Vim finds a line |
5772 at the start of the file indicating that it's not sorted: > | 5778 at the start of the file indicating that it's not sorted: > |
5948 'textwidth' 'tw' number (default 0) | 5954 'textwidth' 'tw' number (default 0) |
5949 local to buffer | 5955 local to buffer |
5950 {not in Vi} | 5956 {not in Vi} |
5951 Maximum width of text that is being inserted. A longer line will be | 5957 Maximum width of text that is being inserted. A longer line will be |
5952 broken after white space to get this width. A zero value disables | 5958 broken after white space to get this width. A zero value disables |
5953 this. 'textwidth' is set to 0 when the 'paste' option is set. When | 5959 this. 'textwidth' is set to 0 when the 'paste' option is set. When |
5954 'textwidth' is zero, 'wrapmargin' may be used. See also | 5960 'textwidth' is zero, 'wrapmargin' may be used. See also |
5955 'formatoptions' and |ins-textwidth|. | 5961 'formatoptions' and |ins-textwidth|. |
5956 NOTE: This option is set to 0 when 'compatible' is set. | 5962 NOTE: This option is set to 0 when 'compatible' is set. |
5957 | 5963 |
5958 *'thesaurus'* *'tsr'* | 5964 *'thesaurus'* *'tsr'* |
5959 'thesaurus' 'tsr' string (default "") | 5965 'thesaurus' 'tsr' string (default "") |
5960 global or local to buffer |global-local| | 5966 global or local to buffer |global-local| |
5961 {not in Vi} | 5967 {not in Vi} |
5962 List of file names, separated by commas, that are used to lookup words | 5968 List of file names, separated by commas, that are used to lookup words |
5963 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in | 5969 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in |
5964 the file should contain words with similar meaning, separated by | 5970 the file should contain words with similar meaning, separated by |
5965 non-keyword characters (white space is preferred). Maximum line | 5971 non-keyword characters (white space is preferred). Maximum line |
5966 length is 510 bytes. | 5972 length is 510 bytes. |
5967 To obtain a file to be used here, check out the wordlist FAQ at | 5973 To obtain a file to be used here, check out the wordlist FAQ at |
5968 http://www.hyphenologist.co.uk . | 5974 http://www.hyphenologist.co.uk . |
5969 To include a comma in a file name precede it with a backslash. Spaces | 5975 To include a comma in a file name precede it with a backslash. Spaces |
5970 after a comma are ignored, otherwise spaces are included in the file | 5976 after a comma are ignored, otherwise spaces are included in the file |
5971 name. See |option-backslash| about using backslashes. | 5977 name. See |option-backslash| about using backslashes. |
5972 The use of |:set+=| and |:set-=| is preferred when adding or removing | 5978 The use of |:set+=| and |:set-=| is preferred when adding or removing |
5973 directories from the list. This avoids problems when a future version | 5979 directories from the list. This avoids problems when a future version |
5974 uses another default. | 5980 uses another default. |
6081 global | 6087 global |
6082 {not in Vi} | 6088 {not in Vi} |
6083 {not available when compiled without the |+title| | 6089 {not available when compiled without the |+title| |
6084 feature} | 6090 feature} |
6085 Gives the percentage of 'columns' to use for the length of the window | 6091 Gives the percentage of 'columns' to use for the length of the window |
6086 title. When the title is longer, only the end of the path name is | 6092 title. When the title is longer, only the end of the path name is |
6087 shown. A '<' character before the path name is used to indicate this. | 6093 shown. A '<' character before the path name is used to indicate this. |
6088 Using a percentage makes this adapt to the width of the window. But | 6094 Using a percentage makes this adapt to the width of the window. But |
6089 it won't work perfectly, because the actual number of characters | 6095 it won't work perfectly, because the actual number of characters |
6090 available also depends on the font used and other things in the title | 6096 available also depends on the font used and other things in the title |
6091 bar. When 'titlelen' is zero the full path is used. Otherwise, | 6097 bar. When 'titlelen' is zero the full path is used. Otherwise, |
6092 values from 1 to 30000 percent can be used. | 6098 values from 1 to 30000 percent can be used. |
6122 < The value of 'titlelen' is used to align items in the middle or right | 6128 < The value of 'titlelen' is used to align items in the middle or right |
6123 of the available space. | 6129 of the available space. |
6124 Some people prefer to have the file name first: > | 6130 Some people prefer to have the file name first: > |
6125 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%) | 6131 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%) |
6126 < Note the use of "%{ }" and an expression to get the path of the file, | 6132 < Note the use of "%{ }" and an expression to get the path of the file, |
6127 without the file name. The "%( %)" constructs are used to add a | 6133 without the file name. The "%( %)" constructs are used to add a |
6128 separating space only when needed. | 6134 separating space only when needed. |
6129 NOTE: Use of special characters in 'titlestring' may cause the display | 6135 NOTE: Use of special characters in 'titlestring' may cause the display |
6130 to be garbled (e.g., when it contains a CR or NL character). | 6136 to be garbled (e.g., when it contains a CR or NL character). |
6131 {not available when compiled without the |+statusline| feature} | 6137 {not available when compiled without the |+statusline| feature} |
6132 | 6138 |
6133 *'toolbar'* *'tb'* | 6139 *'toolbar'* *'tb'* |
6134 'toolbar' 'tb' string (default "icons,tooltips") | 6140 'toolbar' 'tb' string (default "icons,tooltips") |
6135 global | 6141 global |
6136 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and | 6142 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and |
6137 |+GUI_Photon|} | 6143 |+GUI_Photon|} |
6138 The contents of this option controls various toolbar settings. The | 6144 The contents of this option controls various toolbar settings. The |
6139 possible values are: | 6145 possible values are: |
6140 icons Toolbar buttons are shown with icons. | 6146 icons Toolbar buttons are shown with icons. |
6141 text Toolbar buttons shown with text. | 6147 text Toolbar buttons shown with text. |
6142 horiz Icon and text of a toolbar button are | 6148 horiz Icon and text of a toolbar button are |
6143 horizontally arranged. {only in GTK+ 2 GUI} | 6149 horizontally arranged. {only in GTK+ 2 GUI} |
6144 tooltips Tooltips are active for toolbar buttons. | 6150 tooltips Tooltips are active for toolbar buttons. |
6145 Tooltips refer to the popup help text which appears after the mouse | 6151 Tooltips refer to the popup help text which appears after the mouse |
6146 cursor is placed over a toolbar button for a brief moment. | 6152 cursor is placed over a toolbar button for a brief moment. |
6147 | 6153 |
6148 If you want the toolbar to be shown with icons as well as text, do the | 6154 If you want the toolbar to be shown with icons as well as text, do the |
6350 global | 6356 global |
6351 {not in Vi} | 6357 {not in Vi} |
6352 {not available when compiled without the +mksession | 6358 {not available when compiled without the +mksession |
6353 feature} | 6359 feature} |
6354 Changes the effect of the |:mkview| command. It is a comma separated | 6360 Changes the effect of the |:mkview| command. It is a comma separated |
6355 list of words. Each word enables saving and restoring something: | 6361 list of words. Each word enables saving and restoring something: |
6356 word save and restore ~ | 6362 word save and restore ~ |
6357 cursor cursor position in file and in window | 6363 cursor cursor position in file and in window |
6358 folds manually created folds, opened/closed folds and local | 6364 folds manually created folds, opened/closed folds and local |
6359 fold options | 6365 fold options |
6360 options options and mappings local to a window or buffer (not | 6366 options options and mappings local to a window or buffer (not |
6376 global | 6382 global |
6377 {not in Vi} | 6383 {not in Vi} |
6378 {not available when compiled without the |+viminfo| | 6384 {not available when compiled without the |+viminfo| |
6379 feature} | 6385 feature} |
6380 When non-empty, the viminfo file is read upon startup and written | 6386 When non-empty, the viminfo file is read upon startup and written |
6381 when exiting Vim (see |viminfo-file|). The string should be a comma | 6387 when exiting Vim (see |viminfo-file|). The string should be a comma |
6382 separated list of parameters, each consisting of a single character | 6388 separated list of parameters, each consisting of a single character |
6383 identifying the particular parameter, followed by a number or string | 6389 identifying the particular parameter, followed by a number or string |
6384 which specifies the value of that parameter. If a particular | 6390 which specifies the value of that parameter. If a particular |
6385 character is left out, then the default value is used for that | 6391 character is left out, then the default value is used for that |
6386 parameter. The following is a list of the identifying characters and | 6392 parameter. The following is a list of the identifying characters and |
6395 backslash before the ", otherwise it will be recognized as the | 6401 backslash before the ", otherwise it will be recognized as the |
6396 start of a comment! | 6402 start of a comment! |
6397 % When included, save and restore the buffer list. If Vim is | 6403 % When included, save and restore the buffer list. If Vim is |
6398 started with a file name argument, the buffer list is not | 6404 started with a file name argument, the buffer list is not |
6399 restored. If Vim is started without a file name argument, the | 6405 restored. If Vim is started without a file name argument, the |
6400 buffer list is restored from the viminfo file. Buffers | 6406 buffer list is restored from the viminfo file. Buffers |
6401 without a file name and buffers for help files are not written | 6407 without a file name and buffers for help files are not written |
6402 to the viminfo file. | 6408 to the viminfo file. |
6403 ' Maximum number of previously edited files for which the marks | 6409 ' Maximum number of previously edited files for which the marks |
6404 are remembered. This parameter must always be included when | 6410 are remembered. This parameter must always be included when |
6405 'viminfo' is non-empty. | 6411 'viminfo' is non-empty. |
6406 Including this item also means that the |jumplist| and the | 6412 Including this item also means that the |jumplist| and the |
6407 |changelist| are stored in the viminfo file. | 6413 |changelist| are stored in the viminfo file. |
6408 / Maximum number of items in the search pattern history to be | 6414 / Maximum number of items in the search pattern history to be |
6409 saved. If non-zero, then the previous search and substitute | 6415 saved. If non-zero, then the previous search and substitute |
6410 patterns are also saved. When not included, the value of | 6416 patterns are also saved. When not included, the value of |
6411 'history' is used. | 6417 'history' is used. |
6412 : Maximum number of items in the command-line history to be | 6418 : Maximum number of items in the command-line history to be |
6413 saved. When not included, the value of 'history' is used. | 6419 saved. When not included, the value of 'history' is used. |
6414 < Maximum number of lines saved for each register. If zero then | 6420 < Maximum number of lines saved for each register. If zero then |
6415 registers are not saved. When not included, all lines are | 6421 registers are not saved. When not included, all lines are |
6416 saved. '"' is the old name for this item. | 6422 saved. '"' is the old name for this item. |
6417 Also see the 's' item below: limit specified in Kbyte. | 6423 Also see the 's' item below: limit specified in Kbyte. |
6418 @ Maximum number of items in the input-line history to be | 6424 @ Maximum number of items in the input-line history to be |
6419 saved. When not included, the value of 'history' is used. | 6425 saved. When not included, the value of 'history' is used. |
6420 c When included, convert the text in the viminfo file from the | 6426 c When included, convert the text in the viminfo file from the |
6421 'encoding' used when writing the file to the current | 6427 'encoding' used when writing the file to the current |
6422 'encoding'. See |viminfo-encoding|. | 6428 'encoding'. See |viminfo-encoding|. |
6423 f Whether file marks need to be stored. If zero, file marks ('0 | 6429 f Whether file marks need to be stored. If zero, file marks ('0 |
6424 to '9, 'A to 'Z) are not stored. When not present or when | 6430 to '9, 'A to 'Z) are not stored. When not present or when |
6425 non-zero, they are all stored. '0 is used for the current | 6431 non-zero, they are all stored. '0 is used for the current |
6426 cursor position (when exiting or when doing ":wviminfo"). | 6432 cursor position (when exiting or when doing ":wviminfo"). |
6427 h Disable the effect of 'hlsearch' when loading the viminfo | 6433 h Disable the effect of 'hlsearch' when loading the viminfo |
6428 file. When not included, it depends on whether ":nohlsearch" | 6434 file. When not included, it depends on whether ":nohlsearch" |
6429 has been used since the last search command. | 6435 has been used since the last search command. |
6430 n Name of the viminfo file. The name must immediately follow | 6436 n Name of the viminfo file. The name must immediately follow |
6629 *'wildmode'* *'wim'* | 6635 *'wildmode'* *'wim'* |
6630 'wildmode' 'wim' string (Vim default: "full") | 6636 'wildmode' 'wim' string (Vim default: "full") |
6631 global | 6637 global |
6632 {not in Vi} | 6638 {not in Vi} |
6633 Completion mode that is used for the character specified with | 6639 Completion mode that is used for the character specified with |
6634 'wildchar'. It is a comma separated list of up to four parts. Each | 6640 'wildchar'. It is a comma separated list of up to four parts. Each |
6635 part specifies what to do for each consecutive use of 'wildchar. The | 6641 part specifies what to do for each consecutive use of 'wildchar. The |
6636 first part specifies the behavior for the first use of 'wildchar', | 6642 first part specifies the behavior for the first use of 'wildchar', |
6637 The second part for the second use, etc. | 6643 The second part for the second use, etc. |
6638 These are the possible values for each part: | 6644 These are the possible values for each part: |
6639 "" Complete only the first match. | 6645 "" Complete only the first match. |
6676 mapped, but there is no automatic handling. This can then be | 6682 mapped, but there is no automatic handling. This can then be |
6677 done with the |:simalt| command. | 6683 done with the |:simalt| command. |
6678 yes ALT key handling is done by the windowing system. ALT key | 6684 yes ALT key handling is done by the windowing system. ALT key |
6679 combinations cannot be mapped. | 6685 combinations cannot be mapped. |
6680 menu Using ALT in combination with a character that is a menu | 6686 menu Using ALT in combination with a character that is a menu |
6681 shortcut key, will be handled by the windowing system. Other | 6687 shortcut key, will be handled by the windowing system. Other |
6682 keys can be mapped. | 6688 keys can be mapped. |
6683 If the menu is disabled by excluding 'm' from 'guioptions', the ALT | 6689 If the menu is disabled by excluding 'm' from 'guioptions', the ALT |
6684 key is never used for the menu. | 6690 key is never used for the menu. |
6685 In the Win32 version, the <F10> key is handled like this too, since | 6691 In the Win32 version, the <F10> key is handled like this too, since |
6686 Windows uses it to select a menu. | 6692 Windows uses it to select a menu. |
6690 global | 6696 global |
6691 {not in Vi} | 6697 {not in Vi} |
6692 {not available when compiled without the +windows | 6698 {not available when compiled without the +windows |
6693 feature} | 6699 feature} |
6694 Minimal number of lines for the current window. This is not a hard | 6700 Minimal number of lines for the current window. This is not a hard |
6695 minimum, Vim will use fewer lines if there is not enough room. If the | 6701 minimum, Vim will use fewer lines if there is not enough room. If the |
6696 current window is smaller, its size is increased, at the cost of the | 6702 current window is smaller, its size is increased, at the cost of the |
6697 height of other windows. Set it to 999 to make the current window | 6703 height of other windows. Set it to 999 to make the current window |
6698 always fill the screen (although this has the drawback that ":all" | 6704 always fill the screen (although this has the drawback that ":all" |
6699 will create only two windows). Set it to a small number for normal | 6705 will create only two windows). Set it to a small number for normal |
6700 editing. | 6706 editing. |
6769 local to window | 6775 local to window |
6770 {not in Vi} | 6776 {not in Vi} |
6771 This option changes how text is displayed. It doesn't change the text | 6777 This option changes how text is displayed. It doesn't change the text |
6772 in the buffer, see 'textwidth' for that. | 6778 in the buffer, see 'textwidth' for that. |
6773 When on, lines longer than the width of the window will wrap and | 6779 When on, lines longer than the width of the window will wrap and |
6774 displaying continues on the next line. When off lines will not wrap | 6780 displaying continues on the next line. When off lines will not wrap |
6775 and only part of long lines will be displayed. When the cursor is | 6781 and only part of long lines will be displayed. When the cursor is |
6776 moved to a part that is not shown, the screen will scroll | 6782 moved to a part that is not shown, the screen will scroll |
6777 horizontally. | 6783 horizontally. |
6778 The line will be broken in the middle of a word if necessary. See | 6784 The line will be broken in the middle of a word if necessary. See |
6779 'linebreak' to get the break at a word boundary. | 6785 'linebreak' to get the break at a word boundary. |
6780 To make scrolling horizontally a bit more useful, try this: > | 6786 To make scrolling horizontally a bit more useful, try this: > |
6803 'write' boolean (default on) | 6809 'write' boolean (default on) |
6804 global | 6810 global |
6805 {not in Vi} | 6811 {not in Vi} |
6806 Allows writing files. When not set, writing a file is not allowed. | 6812 Allows writing files. When not set, writing a file is not allowed. |
6807 Can be used for a view-only mode, where modifications to the text are | 6813 Can be used for a view-only mode, where modifications to the text are |
6808 still allowed. Can be reset with the |-m| or |-M| command line | 6814 still allowed. Can be reset with the |-m| or |-M| command line |
6809 argument. Filtering text is still possible, even though this requires | 6815 argument. Filtering text is still possible, even though this requires |
6810 writing a temporary file. | 6816 writing a temporary file. |
6811 | 6817 |
6812 *'writeany'* *'wa'* *'nowriteany'* *'nowa'* | 6818 *'writeany'* *'wa'* *'nowriteany'* *'nowa'* |
6813 'writeany' 'wa' boolean (default off) | 6819 'writeany' 'wa' boolean (default off) |