Mercurial > vim

comparison runtime/doc/options.txt @ 12499:d91cf2e26ef0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update runtime files. commit https://github.com/vim/vim/commit/37c64c78fd87e086b5a945ad7032787c274e2dcb Author: Bram Moolenaar <Bram@vim.org> Date: Tue Sep 19 22:06:03 2017 +0200 Update runtime files.
author Christian Brabandt <cb@256bit.org>
date Tue, 19 Sep 2017 22:15:06 +0200
parents 61d910f0999d
children 34c8ec888122
comparison
equal deleted inserted replaced
12498:bf98d339b568 12499:d91cf2e26ef0
1 *options.txt* For Vim version 8.0. Last change: 2017 Aug 27 1 *options.txt* For Vim version 8.0. Last change: 2017 Sep 16
2 2
3 3
4 VIM REFERENCE MANUAL by Bram Moolenaar 4 VIM REFERENCE MANUAL by Bram Moolenaar
5 5
6 6
421 command, not when assigning a value to an option with ":let". 421 command, not when assigning a value to an option with ":let".
422 422
423 *$HOME-windows* 423 *$HOME-windows*
424 On MS-Windows, if $HOME is not defined as an environment variable, then 424 On MS-Windows, if $HOME is not defined as an environment variable, then
425 at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH. 425 at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
426 If $HOMEDRIVE is not set then $USERPROFILE is used.
427
428 This expanded value is not exported to the environment, this matters when
429 running an external command: >
430 :echo system('set | findstr ^HOME=')
431 and >
432 :echo luaeval('os.getenv("HOME")')
433 should echo nothing (an empty string) despite exists('$HOME') being true.
434 When setting $HOME to a non-empty string it will be exported to the
435 subprocesses.
426 436
427 437
428 Note the maximum length of an expanded option is limited. How much depends on 438 Note the maximum length of an expanded option is limited. How much depends on
429 the system, mostly it is something like 256 or 1024 characters. 439 the system, mostly it is something like 256 or 1024 characters.
430 440
720 when the system locale is set to one of CJK locales. See Unicode 730 when the system locale is set to one of CJK locales. See Unicode
721 Standard Annex #11 (http://www.unicode.org/reports/tr11). 731 Standard Annex #11 (http://www.unicode.org/reports/tr11).
722 732
723 Vim may set this option automatically at startup time when Vim is 733 Vim may set this option automatically at startup time when Vim is
724 compiled with the |+termresponse| feature and if |t_u7| is set to the 734 compiled with the |+termresponse| feature and if |t_u7| is set to the
725 escape sequence to request cursor position report. 735 escape sequence to request cursor position report. The response can
736 be found in |v:termu7resp|.
726 737
727 *'antialias'* *'anti'* *'noantialias'* *'noanti'* 738 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
728 'antialias' 'anti' boolean (default: off) 739 'antialias' 'anti' boolean (default: off)
729 global 740 global
730 {not in Vi} 741 {not in Vi}
868 When setting 'background' to the default value with: > 879 When setting 'background' to the default value with: >
869 :set background& 880 :set background&
870 < Vim will guess the value. In the GUI this should work correctly, 881 < Vim will guess the value. In the GUI this should work correctly,
871 in other cases Vim might not be able to guess the right value. 882 in other cases Vim might not be able to guess the right value.
872 883
873 When the t_BG option is set, Vim will use it to request the background 884 When the |t_RB| option is set, Vim will use it to request the background
874 color from the terminal. If the returned RGB value is dark/light and 885 color from the terminal. If the returned RGB value is dark/light and
875 'background' is not dark/light, 'background' will be set and the 886 'background' is not dark/light, 'background' will be set and the
876 screen is redrawn. This may have side effects, make t_BG empty in 887 screen is redrawn. This may have side effects, make t_BG empty in
877 your .vimrc if you suspect this problem. 888 your .vimrc if you suspect this problem. The response to |t_RB| can
889 be found in |v:termrgbresp|.
878 890
879 When starting the GUI, the default value for 'background' will be 891 When starting the GUI, the default value for 'background' will be
880 "light". When the value is not set in the .gvimrc, and Vim detects 892 "light". When the value is not set in the .gvimrc, and Vim detects
881 that the background is actually quite dark, 'background' is set to 893 that the background is actually quite dark, 'background' is set to
882 "dark". But this happens only AFTER the .gvimrc file has been read 894 "dark". But this happens only AFTER the .gvimrc file has been read
4361 'imstyle' 'imst' number (default 1) 4373 'imstyle' 'imst' number (default 1)
4362 global 4374 global
4363 {not in Vi} 4375 {not in Vi}
4364 {only available when compiled with |+xim| and 4376 {only available when compiled with |+xim| and
4365 |+GUI_GTK|} 4377 |+GUI_GTK|}
4366 This option specifies the input style of Input Method. 4378 This option specifies the input style of Input Method:
4367 Set to zero if you want to use on-the-spot style. 4379 0 use on-the-spot style
4368 Set to one if you want to use over-the-spot style. 4380 1 over-the-spot style
4369 See: |xim-input-style| 4381 See: |xim-input-style|
4370 4382
4371 For a long time on-the-spot sytle had been used in GTK version of vim, 4383 For a long time on-the-spot sytle had been used in GTK version of vim,
4372 however, it is known that it causes troubles when using mappings, 4384 however, it is known that it causes troubles when using mappings,
4373 |single-repeat|, etc. Therefore over-the-spot style becomes the 4385 |single-repeat|, etc. Therefore over-the-spot style becomes the
5743 separator. Here is an example to append $INCL, in which directory 5755 separator. Here is an example to append $INCL, in which directory
5744 names are separated with a semi-colon: > 5756 names are separated with a semi-colon: >
5745 :let &path = &path . "," . substitute($INCL, ';', ',', 'g') 5757 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5746 < Replace the ';' with a ':' or whatever separator is used. Note that 5758 < Replace the ';' with a ':' or whatever separator is used. Note that
5747 this doesn't work when $INCL contains a comma or white space. 5759 this doesn't work when $INCL contains a comma or white space.
5760
5761 *'perldll'*
5762 'perldll' string (default depends on the build)
5763 global
5764 {not in Vi}
5765 {only available when compiled with the |+perl/dyn|
5766 feature}
5767 Specifies the name of the Perl shared library. The default is
5768 DYNAMIC_PERL_DLL, which was specified at compile time.
5769 Environment variables are expanded |:set_env|.
5770 This option cannot be set from a |modeline| or in the |sandbox|, for
5771 security reasons.
5748 5772
5749 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* 5773 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5750 'preserveindent' 'pi' boolean (default off) 5774 'preserveindent' 'pi' boolean (default off)
5751 local to buffer 5775 local to buffer
5752 {not in Vi} 5776 {not in Vi}