Nvim :help
pages, generated
from source
using the tree-sitter-vimdoc parser.
GUI
ginit.vim
gui-init
gvimrc
$MYGVIMRC
For GUI-specific configuration Nvim provides the UIEnter event. This
happens after other initializations, or whenever a UI attaches (multiple UIs
can connect to any Nvim instance).:autocmd UIEnter * let g:gui = filter(nvim_list_uis(),{k,v-> v.chan==v:event.chan})[0].rgb
:winp
:winpos
E188
:winp[os]
Display current position of the top left corner of the GUI vim
window in pixels. Does not work in all versions.
Also see getwinpos(), getwinposx() and getwinposy().{X}
{Y}
E466
Put the GUI vim window at the given {X}
and {Y}
coordinates.
The coordinates should specify the position in pixels of the
top left corner of the window.
When the GUI window has not been opened yet, the values are
remembered until the window is opened. The position is
adjusted to make the window fit on the screen (if possible).:wi
:win
:winsize
E465
:win[size] {width}
{height}
Set the window height to {width}
by {height}
characters.
Obsolete, use ":set lines=11 columns=22".:set guioptions=mlrb
):
+------------------------------+ ` | File Edit Help | <- Menu bar (m) ` +-+--------------------------+-+ ` |^| |^| ` |#| Text area. |#| ` | | | | ` |v|__________________________|v| ` Normal status line -> |-+ File.c 5,2 +-| ` between Vim windows |^|""""""""""""""""""""""""""|^| ` | | | | ` | | Another file buffer. | | ` | | | | ` |#| |#| ` Left scrollbar (l) -> |#| |#| <- Right ` |#| |#| scrollbar (r) ` | | | | ` |v| |v| ` +-+--------------------------+-+ ` | |< #### >| | <- Bottom ` +-+--------------------------+-+ scrollbar (b) `
using-menus
menu.vim
The default menus are read from the file "$VIMRUNTIME/menu.vim". See
$VIMRUNTIME for where the path comes from. You can set up your own menus.
Starting off with the default set is a good idea. You can add more items, or,
if you don't like the defaults at all, start with removing all menus
:unmenu-all. You can also avoid the default menus being loaded by adding
this line to your vimrc file (NOT your gvimrc file!)::let did_install_default_menus = 1If you also want to avoid the Syntax menu:
:let did_install_syntax_menu = 1The first item in the Syntax menu can be used to show all available filetypes in the menu (which can take a bit of time to load). If you want to have all filetypes already present at startup, add:
:let do_syntax_sel_menu = 1Note that the menu.vim is sourced when
:syntax on
or :filetype on
is
executed or after your .vimrc file is sourced. This means that the 'encoding'
option and the language of messages (:language messages
) must be set before
that (if you want to change them).console-menus
Although this documentation is in the GUI section, you can actually use menus
in console mode too. You will have to load menu.vim explicitly then, it is
not done by default. You can use the :emenu command and command-line
completion with 'wildmenu' to access the menu entries almost like a real menu
system. To do this, put these commands in your vimrc file::source $VIMRUNTIME/menu.vim :set wildmenu :set cpo-=< :set wcm=<C-Z> :map <F4> :emenu <C-Z>Pressing
<F4>
will start the menu. You can now use the cursor keys to select
a menu entry. Hit <Enter>
to execute it. Hit <Esc>
if you want to cancel.creating-menus
:me
:menu
:noreme
:noremenu
E330
E327
E331
E336
E333
E328
E329
E337
E792
To create a new menu item, use the ":menu" commands. They are mostly like
the ":map" set of commands (see map-modes), but the first argument is a menu
item name, given as a path of menus and submenus with a '.' between them,
e.g.::menu File.Save :w<CR> :inoremenu File.Save <C-O>:w<CR> :menu Edit.Big\ Changes.Delete\ All\ Spaces :%s/[ ^I]//g<CR>This last one will create a new item in the menu bar called "Edit", holding the mouse button down on this will pop up a menu containing the item "Big Changes", which is a sub-menu containing the item "Delete All Spaces", which when selected, performs the operation.
menu-shortcut
& The next character is the shortcut key. Make sure each
shortcut key is only used once in a (sub)menu. If you want to
insert a literal "&" in the menu name use "&&".
menu-text
<Tab>
Separates the menu name from right-aligned text. This can be
used to show the equivalent typed command. The text "<Tab>"
can be used here for convenience. If you are using a real
tab, don't forget to put a backslash before it!
Example::amenu &File.&Open<Tab>:e :browse e<CR>[typed literally] With the shortcut "F" (while keeping the
<Alt>
key pressed), and then "O",
this menu can be used. The second part is shown as "Open :e". The ":e"
is right aligned, and the "O" is underlined, to indicate it is the shortcut.:am
:amenu
:an
:anoremenu
The ":amenu" command can be used to define menu entries for all modes at once,
except for Terminal mode. To make the command work correctly, a character is
automatically inserted for some modes:
<C-C>
<C-\>
<C-G>
Insert <C-\>
<C-O>
Cmdline <C-C>
<C-\>
<C-G>
Op-pending <C-C>
<C-\>
<C-G>
:amenu File.Next :next^Mis equal to:
:nmenu File.Next :next^M :vmenu File.Next ^C:next^M^\^G :imenu File.Next ^\^O:next^M :cmenu File.Next ^C:next^M^\^G :omenu File.Next ^C:next^M^\^GCareful: In Insert mode this only works for a SINGLE Normal mode command, because of the
CTRL-O
. If you have two or more commands, you will need to use
the ":imenu" command. For inserting text in any mode, you can use the
expression register::amenu Insert.foobar "='foobar'<CR>PThe special text
<Cmd>
begins a "command menu", it executes the command
directly without changing modes. Where you might use ":...<CR>" you can
instead use "<Cmd>...<CR>". See <Cmd> for more info. Example:anoremenu File.Next <Cmd>next<CR>Note that
<Esc>
in Cmdline mode executes the command, like in a mapping. This
is Vi compatible. Use CTRL-C
to quit Cmdline mode.:nme
:nmenu
:nnoreme
:nnoremenu
:nunme
:nunmenu
Menu commands starting with "n" work in Normal mode. mapmode-n:ome
:omenu
:onoreme
:onoremenu
:ounme
:ounmenu
Menu commands starting with "o" work in Operator-pending mode. mapmode-o:vme
:vmenu
:vnoreme
:vnoremenu
:vunme
:vunmenu
Menu commands starting with "v" work in Visual mode. mapmode-v:xme
:xmenu
:xnoreme
:xnoremenu
:xunme
:xunmenu
Menu commands starting with "x" work in Visual and Select mode. mapmode-x:sme
:smenu
:snoreme
:snoremenu
:sunme
:sunmenu
Menu commands starting with "s" work in Select mode. mapmode-s:ime
:imenu
:inoreme
:inoremenu
:iunme
:iunmenu
Menu commands starting with "i" work in Insert mode. mapmode-i:cme
:cmenu
:cnoreme
:cnoremenu
:cunme
:cunmenu
Menu commands starting with "c" work in Cmdline mode. mapmode-c:tlm
:tlmenu
:tln
:tlnoremenu
:tlu
:tlunmenu
Menu commands starting with "tl" work in Terminal mode. mapmode-t:menu-<silent>
:menu-silent
To define a menu which will not be echoed on the command line, add
"<silent>" as the first argument. Example::menu <silent> Settings.Ignore\ case :set ic<CR>The ":set ic" will not be echoed when using this menu. Messages from the executed command are still given though. To shut them up too, add a ":silent" in the executed command:
:menu <silent> Search.Header :exe ":silent normal /Header\r"<CR>"<silent>" may also appear just after "<script>".
:menu-<script>
:menu-script
The "to" part of the menu will be inspected for mappings. If you don't want
this, use the ":noremenu" command (or the similar one for a specific mode).
If you do want to use script-local mappings, add "<script>" as the very first
argument to the ":menu" command or just after "<silent>".menu-priority
You can give a priority to a menu. Menus with a higher priority go more to
the right. The priority is given as a number before the ":menu" command.
Example::80menu Buffer.next :bn<CR>The default menus have these priorities: File 10 Edit 20 Tools 40 Syntax 50 Buffers 60 Window 70 Help 9999
sub-menu-priority
The same mechanism can be used to position a sub-menu. The priority is then
given as a dot-separated list of priorities, before the menu name::menu 80.500 Buffer.next :bn<CR>Giving the sub-menu priority is only needed when the item is not to be put in a normal position. For example, to put a sub-menu before the other items:
:menu 80.100 Buffer.first :brew<CR>Or to put a sub-menu after the other items, and further items with default priority will be put before it:
:menu 80.900 Buffer.last :blast<CR>When a number is missing, the default value 500 will be used:
:menu .900 myMenu.test :echo "text"<CR>The menu priority is only used when creating a new menu. When it already existed, e.g., in another mode, the priority will not change. Thus, the priority only needs to be given the first time a menu is used. An exception is the PopUp menu. There is a separate menu for each mode (Normal, Op-pending, Visual, Insert, Cmdline). The order in each of these menus can be different. This is different from menu-bar menus, which have the same order for all modes. NOTE: sub-menu priorities currently don't work for all versions of the GUI.
menu-separator
E332
Menu items can be separated by a special item that inserts some space between
items. Depending on the system this is displayed as a line or a dotted line.
These items must start with a '-' and end in a '-'. The part in between is
used to give it a unique name. Priorities can be used as with normal items.
Example::menu Example.item1 :do something :menu Example.-Sep- : :menu Example.item2 :do something differentNote that the separator also requires a rhs. It doesn't matter what it is, because the item will never be selected. Use a single colon to keep it simple.
gui-toolbar
The default toolbar is setup in menu.vim. The display of the toolbar is
controlled by the 'guioptions' letter 'T'. You can thus have menu & toolbar
together, or either on its own, or neither. The appearance is controlled by
the 'toolbar' option. You can choose between an image, text or both.toolbar-icon
The toolbar is defined as a special menu called ToolBar, which only has one
level. Vim interprets the items in this menu as follows:
1) If an "icon=" argument was specified, the file with this name is used.
The file can either be specified with the full path or with the base name.
In the last case it is searched for in the "bitmaps" directory in
'runtimepath', like in point 3. Examples::amenu icon=/usr/local/pixmaps/foo_icon.xpm ToolBar.Foo :echo "Foo"<CR> :amenu icon=FooIcon ToolBar.Foo :echo "Foo"<CR>
:amenu icon=foo 1.42 ToolBar.Foo :echo "42!"<CR>2) An item called 'BuiltIn##', where ## is a number, is taken as number ## of the built-in bitmaps available in Vim. Currently there are 31 numbered from 0 to 30 which cover most common editing operations builtin-tools.
:amenu ToolBar.BuiltIn22 :call SearchNext("back")<CR>3) An item with another name is first searched for in the directory "bitmaps" in 'runtimepath'. If found, the bitmap file is used as the toolbar button image. Note that the exact filename is OS-specific: For example, under Win32 the command
:amenu ToolBar.Hello :echo "hello"<CR>
:amenu ToolBar.Open :e
builtin-tools
popup-menu
You can define the special menu "PopUp". This is the menu that is displayed
when the right mouse button is pressed, if 'mousemodel' is set to popup or
popup_setpos.anoremenu PopUp.Go\ to\ definition <Cmd>lua vim.lsp.buf.definition()<CR>
amenu PopUp.Open\ in\ web\ browser gx
anoremenu PopUp.Inspect <Cmd>Inspect<CR>
anoremenu PopUp.-1- <Nop>
vnoremenu PopUp.Cut "+x
vnoremenu PopUp.Copy "+y
anoremenu PopUp.Paste "+gP
vnoremenu PopUp.Paste "+P
vnoremenu PopUp.Delete "_x
nnoremenu PopUp.Select\ All ggVG
vnoremenu PopUp.Select\ All gg0oG$
inoremenu PopUp.Select\ All <C-Home><C-O>VG
anoremenu PopUp.-2- <Nop>
anoremenu PopUp.How-to\ disable\ mouse <Cmd>help disable-mouse<CR>
showing-menus
<Tab>
while entering a menu name after a menu command may
be used to complete the name of the menu item.execute-menus
:em
:emenu
E334
E335
:[range]em[enu] {menu}
Execute {menu}
from the command line.
The default is to execute the Normal mode
menu. If a range is specified, it executes
the Visual mode menu.
If used from <c-o>
, it executes the
insert-mode menu Eg::emenu File.Exit:[range]em[enu]
{mode}
{menu}
Like above, but execute the menu for {mode}
:
'n': :nmenu Normal mode
'v': :vmenu Visual mode
's': :smenu Select mode
'o': :omenu Operator-pending mode
't': :tlmenu Terminal mode
'i': :imenu Insert mode
'c': :cmenu Cmdline modedelete-menus
:unme
:unmenu
:aun
:aunmenu
To delete a menu item or a whole submenu, use the unmenu commands, which are
analogous to the unmap commands. Eg::unmenu! Edit.PasteThis will remove the Paste item from the Edit menu for Insert and Command-line modes.
<Tab>
while entering a menu name after an umenu command
may be used to complete the name of the menu item for the appropriate mode.:unmenu-all
:unmenu * " remove all menus in Normal and visual mode :unmenu! * " remove all menus in Insert and Command-line mode :aunmenu * " remove all menus in all modes, except for Terminal " mode :tlunmenu * " remove all menus in Terminal modeIf you want to get rid of the menu bar:
:set guioptions-=mDisabling Menus
disable-menus
:menu-disable
:menu-enable
If you do not want to remove a menu, but disable it for a moment, this can be
done by adding the "enable" or "disable" keyword to a ":menu" command.
Examples::menu disable &File.&Open\.\.\. :amenu enable * :amenu disable &Tools.*The command applies to the modes as used with all menu commands. Note that characters like "&" need to be included for translated names to be found. When the argument is "*", all menus are affected. Otherwise the given menu name and all existing submenus below it are affected.
menu-examples
:nmenu Words.Add\ Var wb"zye:menu! Words.<C-R>z <C-R>z<CR> :nmenu Words.Remove\ Var wb"zye:unmenu! Words.<C-R>z<CR> :vmenu Words.Add\ Var "zy:menu! Words.<C-R>z <C-R>z <CR> :vmenu Words.Remove\ Var "zy:unmenu! Words.<C-R>z<CR> :imenu Words.Add\ Var <Esc>wb"zye:menu! Words.<C-R>z <C-R>z<CR>a :imenu Words.Remove\ Var <Esc>wb"zye:unmenu! Words.<C-R>z<CR>a(the rhs is in <> notation, you can copy/paste this text to try out the mappings, or put these lines in your gvimrc; "<C-R>" is
CTRL-R
, "<CR>" is
the <CR>
key. <>):tunmenu
:tu[nmenu] {menupath}
Remove a tip for a menu or tool.
(only in X11 and Win32 GUI):amenu MyMenu.Hello :echo "Hello"<CR>The tip is defined like this:
:tmenu MyMenu.Hello Displays a greeting.And delete it with:
:tunmenu MyMenu.HelloTooltips are currently only supported for the X11 and Win32 GUI. However, they should appear for the other gui platforms in the not too distant future.
:popup
:popu
:popu[p] {name}
Popup the menu {name}
. The menu named must
have at least one subentry, but need not
appear on the menu-bar (see hidden-menus).{name}
Like above, but use the position of the mouse
pointer instead of the cursor.:popup Filewill make the "File" menu (if there is one) appear at the text cursor (mouse pointer if ! was used).
:amenu ]Toolbar.Make :make<CR> :popup ]ToolbarThis creates a popup menu that doesn't exist on the main menu-bar.