comparison runtime/doc/options.txt @ 17771:4bd21046902b v8.1.1882

patch 8.1.1882: cannot specify properties of the info popup window commit https://github.com/vim/vim/commit/62a0cb443c3184f24a6dac73d3505f9056cf6056 Author: Bram Moolenaar <Bram@vim.org> Date: Sun Aug 18 16:35:23 2019 +0200 patch 8.1.1882: cannot specify properties of the info popup window Problem: Cannot specify properties of the info popup window. Solution: Add the 'completepopup' option. Default to PmenuSel highlight.
author Bram Moolenaar <Bram@vim.org>
date Sun, 18 Aug 2019 16:45:03 +0200
parents c75da1064e33
children 59f8948b7590
comparison
equal deleted inserted replaced
17770:eaa74e51248c 17771:4bd21046902b
1 *options.txt* For Vim version 8.1. Last change: 2019 Aug 17 1 *options.txt* For Vim version 8.1. Last change: 2019 Aug 18
2 2
3 3
4 VIM REFERENCE MANUAL by Bram Moolenaar 4 VIM REFERENCE MANUAL by Bram Moolenaar
5 5
6 6
1916 combination with "menu" or "menuone". 1916 combination with "menu" or "menuone".
1917 1917
1918 popup Show extra information about the currently selected 1918 popup Show extra information about the currently selected
1919 completion in a popup window. Only works in combination 1919 completion in a popup window. Only works in combination
1920 with "menu" or "menuone". Overrides "preview". 1920 with "menu" or "menuone". Overrides "preview".
1921 See |'completepopup'| for specifying properties.
1921 {only works when compiled with the +textprop feature} 1922 {only works when compiled with the +textprop feature}
1922 1923
1923 noinsert Do not insert any text for a match until the user selects 1924 noinsert Do not insert any text for a match until the user selects
1924 a match from the menu. Only works in combination with 1925 a match from the menu. Only works in combination with
1925 "menu" or "menuone". No effect if "longest" is present. 1926 "menu" or "menuone". No effect if "longest" is present.
1926 1927
1927 noselect Do not select a match in the menu, force the user to 1928 noselect Do not select a match in the menu, force the user to
1928 select one from the menu. Only works in combination with 1929 select one from the menu. Only works in combination with
1929 "menu" or "menuone". 1930 "menu" or "menuone".
1931
1932
1933 *'completepopup'* *'cpp'*
1934 'completepopup' 'cpp' string (default empty)
1935 global
1936 {not available when compiled without the |+textprop|
1937 or |+quickfix| feature}
1938 When 'completeopt' contains "popup" then this option is used for the
1939 properties of the info popup. See |complete-popup|.
1930 1940
1931 1941
1932 *'concealcursor'* *'cocu'* 1942 *'concealcursor'* *'cocu'*
1933 'concealcursor' 'cocu' string (default: "") 1943 'concealcursor' 'cocu' string (default: "")
1934 local to window 1944 local to window
3158 Only normal file name characters can be used, "/\*?[|<>" are illegal. 3168 Only normal file name characters can be used, "/\*?[|<>" are illegal.
3159 3169
3160 *'fillchars'* *'fcs'* 3170 *'fillchars'* *'fcs'*
3161 'fillchars' 'fcs' string (default "vert:|,fold:-") 3171 'fillchars' 'fcs' string (default "vert:|,fold:-")
3162 global 3172 global
3163 {not available when compiled without the |+windows| 3173 {not available when compiled without the |+folding|
3164 and |+folding| features} 3174 feature}
3165 Characters to fill the statuslines and vertical separators. 3175 Characters to fill the statuslines and vertical separators.
3166 It is a comma separated list of items: 3176 It is a comma separated list of items:
3167 3177
3168 item default Used for ~ 3178 item default Used for ~
3169 stl:c ' ' or '^' statusline of the current window 3179 stl:c ' ' or '^' statusline of the current window
3795 I/O to/from shell commands. See |gui-pty|. 3805 I/O to/from shell commands. See |gui-pty|.
3796 3806
3797 *'guitablabel'* *'gtl'* 3807 *'guitablabel'* *'gtl'*
3798 'guitablabel' 'gtl' string (default empty) 3808 'guitablabel' 'gtl' string (default empty)
3799 global 3809 global
3800 {only available when compiled with GUI enabled and 3810 {only available when compiled with GUI enabled}
3801 with the |+windows| feature}
3802 When nonempty describes the text to use in a label of the GUI tab 3811 When nonempty describes the text to use in a label of the GUI tab
3803 pages line. When empty and when the result is empty Vim will use a 3812 pages line. When empty and when the result is empty Vim will use a
3804 default label. See |setting-guitablabel| for more info. 3813 default label. See |setting-guitablabel| for more info.
3805 3814
3806 The format of this option is like that of 'statusline'. 3815 The format of this option is like that of 'statusline'.
3814 used. 3823 used.
3815 3824
3816 *'guitabtooltip'* *'gtt'* 3825 *'guitabtooltip'* *'gtt'*
3817 'guitabtooltip' 'gtt' string (default empty) 3826 'guitabtooltip' 'gtt' string (default empty)
3818 global 3827 global
3819 {only available when compiled with GUI enabled and 3828 {only available when compiled with GUI enabled}
3820 with the |+windows| feature}
3821 When nonempty describes the text to use in a tooltip for the GUI tab 3829 When nonempty describes the text to use in a tooltip for the GUI tab
3822 pages line. When empty Vim will use a default tooltip. 3830 pages line. When empty Vim will use a default tooltip.
3823 This option is otherwise just like 'guitablabel' above. 3831 This option is otherwise just like 'guitablabel' above.
3824 You can include a line break. Simplest method is to use |:let|: > 3832 You can include a line break. Simplest method is to use |:let|: >
3825 :let &guitabtooltip = "line one\nline two" 3833 :let &guitabtooltip = "line one\nline two"
3840 security reasons. 3848 security reasons.
3841 3849
3842 *'helpheight'* *'hh'* 3850 *'helpheight'* *'hh'*
3843 'helpheight' 'hh' number (default 20) 3851 'helpheight' 'hh' number (default 20)
3844 global 3852 global
3845 {not available when compiled without the |+windows|
3846 feature}
3847 Minimal initial height of the help window when it is opened with the 3853 Minimal initial height of the help window when it is opened with the
3848 ":help" command. The initial height of the help window is half of the 3854 ":help" command. The initial height of the help window is half of the
3849 current window, or (when the 'ea' option is on) the same as other 3855 current window, or (when the 'ea' option is on) the same as other
3850 windows. When the height is less than 'helpheight', the height is 3856 windows. When the height is less than 'helpheight', the height is
3851 set to 'helpheight'. Set to zero to disable. 3857 set to 'helpheight'. Set to zero to disable.
5640 Use |:retab| to clean up white space. 5646 Use |:retab| to clean up white space.
5641 5647
5642 *'previewheight'* *'pvh'* 5648 *'previewheight'* *'pvh'*
5643 'previewheight' 'pvh' number (default 12) 5649 'previewheight' 'pvh' number (default 12)
5644 global 5650 global
5645 {not available when compiled without the |+windows| or 5651 {not available when compiled without the |+quickfix|
5646 |+quickfix| features} 5652 feature}
5647 Default height for a preview window. Used for |:ptag| and associated 5653 Default height for a preview window. Used for |:ptag| and associated
5648 commands. Used for |CTRL-W_}| when no count is given. Not used when 5654 commands. Used for |CTRL-W_}| when no count is given. Not used when
5649 'previewpopup' is set. 5655 'previewpopup' is set.
5650 5656
5651 *'previewpopup'* *'pvp'* 5657 *'previewpopup'* *'pvp'*
5652 'previewpopup' 'pvp' string (default empty) 5658 'previewpopup' 'pvp' string (default empty)
5653 global 5659 global
5654 {not available when compiled without the |+windows|, 5660 {not available when compiled without the |+textprop|
5655 |+textprop| or |+quickfix| feature} 5661 or |+quickfix| feature}
5656 When not empty a popup window is used for commands that would open a 5662 When not empty a popup window is used for commands that would open a
5657 preview window. See |preview-popup|. 5663 preview window. See |preview-popup|.
5658 Not used for the insert completion info, add "popup" to 5664 Not used for the insert completion info, add "popup" to
5659 'completeopt' for that. 5665 'completeopt' for that.
5660 5666
5661 *'previewwindow'* *'nopreviewwindow'* 5667 *'previewwindow'* *'nopreviewwindow'*
5662 *'pvw'* *'nopvw'* *E590* 5668 *'pvw'* *'nopvw'* *E590*
5663 'previewwindow' 'pvw' boolean (default off) 5669 'previewwindow' 'pvw' boolean (default off)
5664 local to window 5670 local to window
5665 {not available when compiled without the |+windows| or 5671 {not available when compiled without the |+quickfix|
5666 |+quickfix| features} 5672 feature}
5667 Identifies the preview window. Only one window can have this option 5673 Identifies the preview window. Only one window can have this option
5668 set. It's normally not set directly, but by using one of the commands 5674 set. It's normally not set directly, but by using one of the commands
5669 |:ptag|, |:pedit|, etc. 5675 |:ptag|, |:pedit|, etc.
5670 5676
5671 *'printdevice'* *'pdev'* 5677 *'printdevice'* *'pdev'*
6779 set and to the Vim default value when 'compatible' is reset. 6785 set and to the Vim default value when 'compatible' is reset.
6780 6786
6781 *'showtabline'* *'stal'* 6787 *'showtabline'* *'stal'*
6782 'showtabline' 'stal' number (default 1) 6788 'showtabline' 'stal' number (default 1)
6783 global 6789 global
6784 {not available when compiled without the |+windows|
6785 feature}
6786 The value of this option specifies when the line with tab page labels 6790 The value of this option specifies when the line with tab page labels
6787 will be displayed: 6791 will be displayed:
6788 0: never 6792 0: never
6789 1: only if there are at least two tab pages 6793 1: only if there are at least two tab pages
6790 2: always 6794 2: always
7077 7081
7078 7082
7079 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'* 7083 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7080 'splitbelow' 'sb' boolean (default off) 7084 'splitbelow' 'sb' boolean (default off)
7081 global 7085 global
7082 {not available when compiled without the |+windows|
7083 feature}
7084 When on, splitting a window will put the new window below the current 7086 When on, splitting a window will put the new window below the current
7085 one. |:split| 7087 one. |:split|
7086 7088
7087 *'splitright'* *'spr'* *'nosplitright'* *'nospr'* 7089 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7088 'splitright' 'spr' boolean (default off) 7090 'splitright' 'spr' boolean (default off)
7399 Only normal file name characters can be used, "/\*?[|<>" are illegal. 7401 Only normal file name characters can be used, "/\*?[|<>" are illegal.
7400 7402
7401 *'tabline'* *'tal'* 7403 *'tabline'* *'tal'*
7402 'tabline' 'tal' string (default empty) 7404 'tabline' 'tal' string (default empty)
7403 global 7405 global
7404 {not available when compiled without the |+windows|
7405 feature}
7406 When nonempty, this option determines the content of the tab pages 7406 When nonempty, this option determines the content of the tab pages
7407 line at the top of the Vim window. When empty Vim will use a default 7407 line at the top of the Vim window. When empty Vim will use a default
7408 tab pages line. See |setting-tabline| for more info. 7408 tab pages line. See |setting-tabline| for more info.
7409 7409
7410 The tab pages line only appears as specified with the 'showtabline' 7410 The tab pages line only appears as specified with the 'showtabline'
7426 7426
7427 7427
7428 *'tabpagemax'* *'tpm'* 7428 *'tabpagemax'* *'tpm'*
7429 'tabpagemax' 'tpm' number (default 10) 7429 'tabpagemax' 'tpm' number (default 10)
7430 global 7430 global
7431 {not available when compiled without the |+windows|
7432 feature}
7433 Maximum number of tab pages to be opened by the |-p| command line 7431 Maximum number of tab pages to be opened by the |-p| command line
7434 argument or the ":tab all" command. |tabpage| 7432 argument or the ":tab all" command. |tabpage|
7435 7433
7436 7434
7437 *'tabstop'* *'ts'* 7435 *'tabstop'* *'ts'*
8737 or equal to 'lines' it will be set to 'lines' minus 1. 8735 or equal to 'lines' it will be set to 'lines' minus 1.
8738 8736
8739 *'winheight'* *'wh'* *E591* 8737 *'winheight'* *'wh'* *E591*
8740 'winheight' 'wh' number (default 1) 8738 'winheight' 'wh' number (default 1)
8741 global 8739 global
8742 {not available when compiled without the |+windows|
8743 feature}
8744 Minimal number of lines for the current window. This is not a hard 8740 Minimal number of lines for the current window. This is not a hard
8745 minimum, Vim will use fewer lines if there is not enough room. If the 8741 minimum, Vim will use fewer lines if there is not enough room. If the
8746 focus goes to a window that is smaller, its size is increased, at the 8742 focus goes to a window that is smaller, its size is increased, at the
8747 cost of the height of other windows. 8743 cost of the height of other windows.
8748 Set 'winheight' to a small number for normal editing. 8744 Set 'winheight' to a small number for normal editing.
8759 the minimal height for other windows. 8755 the minimal height for other windows.
8760 8756
8761 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* 8757 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8762 'winfixheight' 'wfh' boolean (default off) 8758 'winfixheight' 'wfh' boolean (default off)
8763 local to window 8759 local to window
8764 {not available when compiled without the |+windows|
8765 feature}
8766 Keep the window height when windows are opened or closed and 8760 Keep the window height when windows are opened or closed and
8767 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the 8761 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8768 |preview-window| and |quickfix-window|. 8762 |preview-window| and |quickfix-window|.
8769 The height may be changed anyway when running out of room. 8763 The height may be changed anyway when running out of room.
8770 8764
8771 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* 8765 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8772 'winfixwidth' 'wfw' boolean (default off) 8766 'winfixwidth' 'wfw' boolean (default off)
8773 local to window 8767 local to window
8774 {not available when compiled without the |+windows|
8775 feature}
8776 Keep the window width when windows are opened or closed and 8768 Keep the window width when windows are opened or closed and
8777 'equalalways' is set. Also for |CTRL-W_=|. 8769 'equalalways' is set. Also for |CTRL-W_=|.
8778 The width may be changed anyway when running out of room. 8770 The width may be changed anyway when running out of room.
8779 8771
8780 *'winminheight'* *'wmh'* 8772 *'winminheight'* *'wmh'*
8781 'winminheight' 'wmh' number (default 1) 8773 'winminheight' 'wmh' number (default 1)
8782 global 8774 global
8783 {not available when compiled without the |+windows|
8784 feature}
8785 The minimal height of a window, when it's not the current window. 8775 The minimal height of a window, when it's not the current window.
8786 This is a hard minimum, windows will never become smaller. 8776 This is a hard minimum, windows will never become smaller.
8787 When set to zero, windows may be "squashed" to zero lines (i.e. just a 8777 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8788 status bar) if necessary. They will return to at least one line when 8778 status bar) if necessary. They will return to at least one line when
8789 they become active (since the cursor has to have somewhere to go.) 8779 they become active (since the cursor has to have somewhere to go.)