kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-24 13:15:09 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge #31451 docs

Browse Source
This commit is contained in:
Justin M. Keyes 2024-12-05 04:02:34 -08:00 committed by GitHub
commit 845e563421
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 249 additions and 232 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

456
runtime/doc/gui.txt
View File

@ -1,10 +1,10 @@
*gui.txt* Nvim *gui.txt* Nvim
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
Nvim Graphical User Interface *gui* *GUI* Nvim Graphical User Interface *gui* *GUI*
Any client that supports the Nvim |ui-protocol| can be used as a UI for Nvim. Any client that supports the Nvim |ui-protocol| can be used as a UI for Nvim.
And multiple UIs can connect to the same Nvim instance! The terms "UI" and And multiple UIs can connect to the same Nvim instance! The terms "UI" and
@ -20,7 +20,7 @@ features, whereas help tags with the "ui-" prefix refer to the |ui-protocol|.
Nvim provides a default, builtin UI (the |TUI|), but there are many other Nvim provides a default, builtin UI (the |TUI|), but there are many other
(third-party) GUIs that you can use instead: (third-party) GUIs that you can use instead:
*vscode* *vscode*
- vscode-neovim (Nvim in VSCode!) https://github.com/vscode-neovim/vscode-neovim - vscode-neovim (Nvim in VSCode!) https://github.com/vscode-neovim/vscode-neovim
- Firenvim (Nvim in your web browser!) https://github.com/glacambre/firenvim - Firenvim (Nvim in your web browser!) https://github.com/glacambre/firenvim
- Neovide https://neovide.dev/ - Neovide https://neovide.dev/
@ -33,71 +33,71 @@ Nvim provides a default, builtin UI (the |TUI|), but there are many other
Type |gO| to see the table of contents. Type |gO| to see the table of contents.
============================================================================== ==============================================================================
Starting the GUI *gui-config* *gui-start* Starting the GUI *gui-config* *gui-start*
*ginit.vim* *gui-init* *gvimrc* *$MYGVIMRC* *ginit.vim* *gui-init* *gvimrc* *$MYGVIMRC*
For GUI-specific configuration Nvim provides the |UIEnter| event. This For GUI-specific configuration Nvim provides the |UIEnter| event. This
happens after other |initialization|s, or whenever a UI attaches (multiple UIs happens after other |initialization|s, or whenever a UI attaches (multiple UIs
can connect to any Nvim instance). can connect to any Nvim instance).
Example: this sets "g:gui" to the value of the UI's "rgb" field: > Example: this sets "g:gui" to the value of the UI's "rgb" field: >
:autocmd UIEnter * let g:gui = filter(nvim_list_uis(),{k,v-> v.chan==v:event.chan})[0].rgb :autocmd UIEnter * let g:gui = filter(nvim_list_uis(),{k,v-> v.chan==v:event.chan})[0].rgb
< <
*:winp* *:winpos* *E188* *:winp* *:winpos* *E188*
:winp[os] :winp[os]
Display current position of the top left corner of the GUI vim Display current position of the top left corner of the GUI vim
window in pixels. Does not work in all versions. window in pixels. Does not work in all versions.
Also see |getwinpos()|, |getwinposx()| and |getwinposy()|. Also see |getwinpos()|, |getwinposx()| and |getwinposy()|.
:winp[os] {X} {Y} *E466* :winp[os] {X} {Y} *E466*
Put the GUI vim window at the given {X} and {Y} coordinates. Put the GUI vim window at the given {X} and {Y} coordinates.
The coordinates should specify the position in pixels of the The coordinates should specify the position in pixels of the
top left corner of the window. top left corner of the window.
When the GUI window has not been opened yet, the values are When the GUI window has not been opened yet, the values are
remembered until the window is opened. The position is remembered until the window is opened. The position is
adjusted to make the window fit on the screen (if possible). adjusted to make the window fit on the screen (if possible).
*:wi* *:win* *:winsize* *E465* *:wi* *:win* *:winsize* *E465*
:win[size] {width} {height} :win[size] {width} {height}
Set the window height to {width} by {height} characters. Set the window height to {width} by {height} characters.
Obsolete, use ":set lines=11 columns=22". Obsolete, use ":set lines=11 columns=22".
============================================================================== ==============================================================================
Scrollbars *gui-scrollbars* Scrollbars *gui-scrollbars*
There are vertical scrollbars and a horizontal scrollbar. You may There are vertical scrollbars and a horizontal scrollbar. You may
configure which ones appear with the 'guioptions' option. configure which ones appear with the 'guioptions' option.
The interface looks like this (with `:set guioptions=mlrb`): The interface looks like this (with `:set guioptions=mlrb`):
> >
+------------------------------+ ` +------------------------------+ `
| File Edit Help | <- Menu bar (m) ` | File Edit Help | <- Menu bar (m) `
+-+--------------------------+-+ ` +-+--------------------------+-+ `
|^| |^| ` |^| |^| `
|#| Text area. |#| ` |#| Text area. |#| `
| | | | ` | | | | `
|v|__________________________|v| ` |v|__________________________|v| `
Normal status line -> |-+ File.c 5,2 +-| ` Normal status line -> |-+ File.c 5,2 +-| `
between Vim windows |^|""""""""""""""""""""""""""|^| ` between Vim windows |^|""""""""""""""""""""""""""|^| `
| | | | ` | | | | `
| | Another file buffer. | | ` | | Another file buffer. | | `
| | | | ` | | | | `
|#| |#| ` |#| |#| `
Left scrollbar (l) -> |#| |#| <- Right ` Left scrollbar (l) -> |#| |#| <- Right `
|#| |#| scrollbar (r) ` |#| |#| scrollbar (r) `
| | | | ` | | | | `
|v| |v| ` |v| |v| `
+-+--------------------------+-+ ` +-+--------------------------+-+ `
| |< #### >| | <- Bottom ` | |< #### >| | <- Bottom `
+-+--------------------------+-+ scrollbar (b) ` +-+--------------------------+-+ scrollbar (b) `
< <
Any of the scrollbar or menu components may be turned off by not putting the Any of the scrollbar or menu components may be turned off by not putting the
appropriate letter in the 'guioptions' string. The bottom scrollbar is appropriate letter in the 'guioptions' string. The bottom scrollbar is
only useful when 'nowrap' is set. only useful when 'nowrap' is set.
VERTICAL SCROLLBARS *gui-vert-scroll* VERTICAL SCROLLBARS *gui-vert-scroll*
Each Vim window has a scrollbar next to it which may be scrolled up and down Each Vim window has a scrollbar next to it which may be scrolled up and down
to move through the text in that buffer. The size of the scrollbar-thumb to move through the text in that buffer. The size of the scrollbar-thumb
@ -116,7 +116,7 @@ is on the left half, the right scrollbar column will contain scrollbars for
the rightmost windows. The same happens on the other side. the rightmost windows. The same happens on the other side.
HORIZONTAL SCROLLBARS *gui-horiz-scroll* HORIZONTAL SCROLLBARS *gui-horiz-scroll*
The horizontal scrollbar (at the bottom of the Vim GUI) may be used to The horizontal scrollbar (at the bottom of the Vim GUI) may be used to
scroll text sideways when the 'wrap' option is turned off. The scroll text sideways when the 'wrap' option is turned off. The
@ -132,7 +132,7 @@ include the 'h' flag in 'guioptions'. Then the scrolling is limited by the
text of the current cursor line. text of the current cursor line.
============================================================================== ==============================================================================
Drag and drop *drag-n-drop* Drag and drop *drag-n-drop*
You can drag and drop one or more files into the Vim window, where they will You can drag and drop one or more files into the Vim window, where they will
be opened as if a |:drop| command was used. be opened as if a |:drop| command was used.
@ -151,12 +151,12 @@ names with any Ex command. Special characters (space, tab, double quote and
"|"; backslash on non-MS-Windows systems) will be escaped. "|"; backslash on non-MS-Windows systems) will be escaped.
============================================================================== ==============================================================================
Menus *menus* Menus *menus*
For an introduction see |usr_42.txt| in the user manual. For an introduction see |usr_42.txt| in the user manual.
Using Menus *using-menus* Using Menus *using-menus*
Basically, menus can be used just like mappings. You can define your own Basically, menus can be used just like mappings. You can define your own
menus, as many as you like. menus, as many as you like.
@ -166,45 +166,45 @@ what the key sequence was.
For creating menus in a different language, see |:menutrans|. For creating menus in a different language, see |:menutrans|.
*menu.vim* *menu.vim*
The default menus are read from the file "$VIMRUNTIME/menu.vim". See 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. |$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, 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 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 |:unmenu-all|. You can also avoid the default menus being loaded by adding
this line to your vimrc file (NOT your gvimrc file!): > this line to your vimrc file (NOT your gvimrc file!): >
:let did_install_default_menus = 1 :let did_install_default_menus = 1
If you also want to avoid the Syntax menu: > If you also want to avoid the Syntax menu: >
:let did_install_syntax_menu = 1 :let did_install_syntax_menu = 1
The first item in the Syntax menu can be used to show all available filetypes The 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 in the menu (which can take a bit of time to load). If you want to have all
filetypes already present at startup, add: > filetypes already present at startup, add: >
:let do_syntax_sel_menu = 1 :let do_syntax_sel_menu = 1
Note that the menu.vim is sourced when `:syntax on` or `:filetype on` is Note 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' 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 option and the language of messages (`:language messages`) must be set before
that (if you want to change them). that (if you want to change them).
*console-menus* *console-menus*
Although this documentation is in the GUI section, you can actually use 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 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 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 completion with 'wildmenu' to access the menu entries almost like a real menu
system. To do this, put these commands in your vimrc file: > system. To do this, put these commands in your vimrc file: >
:source $VIMRUNTIME/menu.vim :source $VIMRUNTIME/menu.vim
:set wildmenu :set wildmenu
:set cpo-=< :set cpo-=<
:set wcm=<C-Z> :set wcm=<C-Z>
:map <F4> :emenu <C-Z> :map <F4> :emenu <C-Z>
Pressing <F4> will start the menu. You can now use the cursor keys to select 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. a menu entry. Hit <Enter> to execute it. Hit <Esc> if you want to cancel.
Creating New Menus *creating-menus* Creating New Menus *creating-menus*
*:me* *:menu* *:noreme* *:noremenu* *:me* *:menu* *:noreme* *:noremenu*
*E330* *E327* *E331* *E336* *E333* *E330* *E327* *E331* *E336* *E333*
*E328* *E329* *E337* *E792* *E328* *E329* *E337* *E792*
To create a new menu item, use the ":menu" commands. They are mostly like 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 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, item name, given as a path of menus and submenus with a '.' between them,
@ -225,15 +225,16 @@ tooltips for menus. See |terminal-input|.
Special characters in a menu name: Special characters in a menu name:
*menu-shortcut* *menu-shortcut*
& The next character is the shortcut key. Make sure each - & The next character is the shortcut key. Make sure each shortcut key is
shortcut key is only used once in a (sub)menu. If you want to only used once in a (sub)menu. If you want to insert a literal "&" in the
insert a literal "&" in the menu name use "&&". menu name use "&&".
*menu-text* *menu-text*
<Tab> Separates the menu name from right-aligned text. This can be - <Tab> Separates the menu name from right-aligned text. This can be used to
used to show the equivalent typed command. The text "<Tab>" show the equivalent typed command. The text "<Tab>" can be used here for
can be used here for convenience. If you are using a real convenience. If you are using a real tab, don't forget to put a backslash
tab, don't forget to put a backslash before it! before it!
Example: > Example: >
:amenu &File.&Open<Tab>:e :browse e<CR> :amenu &File.&Open<Tab>:e :browse e<CR>
@ -243,99 +244,99 @@ 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" 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. is right aligned, and the "O" is underlined, to indicate it is the shortcut.
*:am* *:amenu* *:an* *:anoremenu* *:am* *:amenu* *:an* *:anoremenu*
The ":amenu" command can be used to define menu entries for all modes at once, 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 except for Terminal mode. To make the command work correctly, a character is
automatically inserted for some modes: automatically inserted for some modes: >
mode inserted appended ~ mode inserted appended
Normal nothing nothing Normal nothing nothing
Visual <C-C> <C-\><C-G> Visual <C-C> <C-\><C-G>
Insert <C-\><C-O> Insert <C-\><C-O>
Cmdline <C-C> <C-\><C-G> Cmdline <C-C> <C-\><C-G>
Op-pending <C-C> <C-\><C-G> Op-pending <C-C> <C-\><C-G>
<
Example: > Example: >
:amenu File.Next :next^M :amenu File.Next :next^M
is equal to: > is equal to: >
:nmenu File.Next :next^M :nmenu File.Next :next^M
:vmenu File.Next ^C:next^M^\^G :vmenu File.Next ^C:next^M^\^G
:imenu File.Next ^\^O:next^M :imenu File.Next ^\^O:next^M
:cmenu File.Next ^C:next^M^\^G :cmenu File.Next ^C:next^M^\^G
:omenu File.Next ^C:next^M^\^G :omenu File.Next ^C:next^M^\^G
Careful: In Insert mode this only works for a SINGLE Normal mode command, Careful: 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 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 the ":imenu" command. For inserting text in any mode, you can use the
expression register: > expression register: >
:amenu Insert.foobar "='foobar'<CR>P :amenu Insert.foobar "='foobar'<CR>P
The special text <Cmd> begins a "command menu", it executes the command The special text <Cmd> begins a "command menu", it executes the command
directly without changing modes. Where you might use ":...<CR>" you can directly without changing modes. Where you might use ":...<CR>" you can
instead use "<Cmd>...<CR>". See |<Cmd>| for more info. Example: > instead use "<Cmd>...<CR>". See |<Cmd>| for more info. Example: >
anoremenu File.Next <Cmd>next<CR> anoremenu File.Next <Cmd>next<CR>
Note that <Esc> in Cmdline mode executes the command, like in a mapping. This Note that <Esc> in Cmdline mode executes the command, like in a mapping. This
is Vi compatible. Use CTRL-C to quit Cmdline mode. is Vi compatible. Use CTRL-C to quit Cmdline mode.
*:nme* *:nmenu* *:nnoreme* *:nnoremenu* *:nunme* *:nunmenu* *:nme* *:nmenu* *:nnoreme* *:nnoremenu* *:nunme* *:nunmenu*
Menu commands starting with "n" work in Normal mode. |mapmode-n| Menu commands starting with "n" work in Normal mode. |mapmode-n|
*:ome* *:omenu* *:onoreme* *:onoremenu* *:ounme* *:ounmenu* *:ome* *:omenu* *:onoreme* *:onoremenu* *:ounme* *:ounmenu*
Menu commands starting with "o" work in Operator-pending mode. |mapmode-o| Menu commands starting with "o" work in Operator-pending mode. |mapmode-o|
*:vme* *:vmenu* *:vnoreme* *:vnoremenu* *:vunme* *:vunmenu* *:vme* *:vmenu* *:vnoreme* *:vnoremenu* *:vunme* *:vunmenu*
Menu commands starting with "v" work in Visual mode. |mapmode-v| Menu commands starting with "v" work in Visual mode. |mapmode-v|
*:xme* *:xmenu* *:xnoreme* *:xnoremenu* *:xunme* *:xunmenu* *:xme* *:xmenu* *:xnoreme* *:xnoremenu* *:xunme* *:xunmenu*
Menu commands starting with "x" work in Visual and Select mode. |mapmode-x| Menu commands starting with "x" work in Visual and Select mode. |mapmode-x|
*:sme* *:smenu* *:snoreme* *:snoremenu* *:sunme* *:sunmenu* *:sme* *:smenu* *:snoreme* *:snoremenu* *:sunme* *:sunmenu*
Menu commands starting with "s" work in Select mode. |mapmode-s| Menu commands starting with "s" work in Select mode. |mapmode-s|
*:ime* *:imenu* *:inoreme* *:inoremenu* *:iunme* *:iunmenu* *:ime* *:imenu* *:inoreme* *:inoremenu* *:iunme* *:iunmenu*
Menu commands starting with "i" work in Insert mode. |mapmode-i| Menu commands starting with "i" work in Insert mode. |mapmode-i|
*:cme* *:cmenu* *:cnoreme* *:cnoremenu* *:cunme* *:cunmenu* *:cme* *:cmenu* *:cnoreme* *:cnoremenu* *:cunme* *:cunmenu*
Menu commands starting with "c" work in Cmdline mode. |mapmode-c| Menu commands starting with "c" work in Cmdline mode. |mapmode-c|
*:tlm* *:tlmenu* *:tln* *:tlnoremenu* *:tlu* *:tlunmenu* *:tlm* *:tlmenu* *:tln* *:tlnoremenu* *:tlu* *:tlunmenu*
Menu commands starting with "tl" work in Terminal mode. |mapmode-t| Menu commands starting with "tl" work in Terminal mode. |mapmode-t|
*:menu-<silent>* *:menu-silent* *:menu-<silent>* *:menu-silent*
To define a menu which will not be echoed on the command line, add To define a menu which will not be echoed on the command line, add
"<silent>" as the first argument. Example: > "<silent>" as the first argument. Example: >
:menu <silent> Settings.Ignore\ case :set ic<CR> :menu <silent> Settings.Ignore\ case :set ic<CR>
The ":set ic" will not be echoed when using this menu. Messages from the 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" executed command are still given though. To shut them up too, add a ":silent"
in the executed command: > in the executed command: >
:menu <silent> Search.Header :exe ":silent normal /Header\r"<CR> :menu <silent> Search.Header :exe ":silent normal /Header\r"<CR>
"<silent>" may also appear just after "<script>". "<silent>" may also appear just after "<script>".
*:menu-<script>* *:menu-script* *:menu-<script>* *:menu-script*
The "to" part of the menu will be inspected for mappings. If you don't want 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). 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 If you do want to use script-local mappings, add "<script>" as the very first
argument to the ":menu" command or just after "<silent>". argument to the ":menu" command or just after "<silent>".
*menu-priority* *menu-priority*
You can give a priority to a menu. Menus with a higher priority go more to 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. the right. The priority is given as a number before the ":menu" command.
Example: > Example: >
:80menu Buffer.next :bn<CR> :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
The default menus have these priorities: >
File 10
Edit 20
Tools 40
Syntax 50
Buffers 60
Window 70
Help 9999
<
When no or zero priority is given, 500 is used. When no or zero priority is given, 500 is used.
The priority for the PopUp menu is not used. The priority for the PopUp menu is not used.
@ -343,18 +344,18 @@ You can use a priority higher than 9999, to make it go after the Help menu,
but that is non-standard and is discouraged. The highest possible priority is but that is non-standard and is discouraged. The highest possible priority is
about 32000. The lowest is 1. about 32000. The lowest is 1.
*sub-menu-priority* *sub-menu-priority*
The same mechanism can be used to position a sub-menu. The priority is then 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: > given as a dot-separated list of priorities, before the menu name: >
:menu 80.500 Buffer.next :bn<CR> :menu 80.500 Buffer.next :bn<CR>
Giving the sub-menu priority is only needed when the item is not to be put 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: > in a normal position. For example, to put a sub-menu before the other items: >
:menu 80.100 Buffer.first :brew<CR> :menu 80.100 Buffer.first :brew<CR>
Or to put a sub-menu after the other items, and further items with default Or to put a sub-menu after the other items, and further items with default
priority will be put before it: > priority will be put before it: >
:menu 80.900 Buffer.last :blast<CR> :menu 80.900 Buffer.last :blast<CR>
When a number is missing, the default value 500 will be used: > When a number is missing, the default value 500 will be used: >
:menu .900 myMenu.test :echo "text"<CR> :menu .900 myMenu.test :echo "text"<CR>
The menu priority is only used when creating a new menu. When it already 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 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. priority only needs to be given the first time a menu is used.
@ -364,49 +365,49 @@ menus can be different. This is different from menu-bar menus, which have
the same order for all modes. the same order for all modes.
NOTE: sub-menu priorities currently don't work for all versions of the GUI. NOTE: sub-menu priorities currently don't work for all versions of the GUI.
*menu-separator* *E332* *menu-separator* *E332*
Menu items can be separated by a special item that inserts some space between 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. 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 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. used to give it a unique name. Priorities can be used as with normal items.
Example: > Example: >
:menu Example.item1 :do something :menu Example.item1 :do something
:menu Example.-Sep- : :menu Example.-Sep- :
:menu Example.item2 :do something different :menu Example.item2 :do something different
Note that the separator also requires a rhs. It doesn't matter what it is, Note 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 because the item will never be selected. Use a single colon to keep it
simple. simple.
*gui-toolbar* *gui-toolbar*
The default toolbar is setup in menu.vim. The display of the toolbar is 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 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 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. the 'toolbar' option. You can choose between an image, text or both.
*toolbar-icon* *toolbar-icon*
The toolbar is defined as a special menu called ToolBar, which only has one The toolbar is defined as a special menu called ToolBar, which only has one
level. Vim interprets the items in this menu as follows: level. Vim interprets the items in this menu as follows:
1) If an "icon=" argument was specified, the file with this name is used. - 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. 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 In the last case it is searched for in the "bitmaps" directory in
'runtimepath', like in point 3. Examples: > 'runtimepath', like in point 3. Examples: >
:amenu icon=/usr/local/pixmaps/foo_icon.xpm ToolBar.Foo :echo "Foo"<CR> :amenu icon=/usr/local/pixmaps/foo_icon.xpm ToolBar.Foo :echo "Foo"<CR>
:amenu icon=FooIcon ToolBar.Foo :echo "Foo"<CR> :amenu icon=FooIcon ToolBar.Foo :echo "Foo"<CR>
< Note that in the first case the extension is included, while in the second < Note that in the first case the extension is included, while in the second
case it is omitted. case it is omitted.
If the file cannot be opened the next points are tried. If the file cannot be opened the next points are tried.
A space in the file name must be escaped with a backslash. A space in the file name must be escaped with a backslash.
A menu priority must come _after_ the icon argument: > A menu priority must come _after_ the icon argument: >
:amenu icon=foo 1.42 ToolBar.Foo :echo "42!"<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 - 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 the built-in bitmaps available in Vim. Currently there are 31 numbered
from 0 to 30 which cover most common editing operations |builtin-tools|. > from 0 to 30 which cover most common editing operations |builtin-tools|. >
:amenu ToolBar.BuiltIn22 :call SearchNext("back")<CR> :amenu ToolBar.BuiltIn22 :call SearchNext("back")<CR>
3) An item with another name is first searched for in the directory - 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 "bitmaps" in 'runtimepath'. If found, the bitmap file is used as the
toolbar button image. Note that the exact filename is OS-specific: For toolbar button image. Note that the exact filename is OS-specific: For
example, under Win32 the command > example, under Win32 the command >
:amenu ToolBar.Hello :echo "hello"<CR> :amenu ToolBar.Hello :echo "hello"<CR>
< would find the file 'hello.bmp'. Under X11 it is 'Hello.xpm'. < would find the file 'hello.bmp'. Under X11 it is 'Hello.xpm'.
For MS-Windows and the bitmap is scaled to fit the button. For For MS-Windows and the bitmap is scaled to fit the button. For
MS-Windows a size of 18 by 18 pixels works best. MS-Windows a size of 18 by 18 pixels works best.
@ -414,55 +415,56 @@ level. Vim interprets the items in this menu as follows:
The light grey pixels will be changed to the Window frame color and the The light grey pixels will be changed to the Window frame color and the
dark grey pixels to the window shadow color. More colors might also work, dark grey pixels to the window shadow color. More colors might also work,
depending on your system. depending on your system.
4) If the bitmap is still not found, Vim checks for a match against its list - 4 If the bitmap is still not found, Vim checks for a match against its list
of built-in names. Each built-in button image has a name. of built-in names. Each built-in button image has a name.
So the command > So the command >
:amenu ToolBar.Open :e :amenu ToolBar.Open :e
< will show the built-in "open a file" button image if no open.bmp exists. < will show the built-in "open a file" button image if no open.bmp exists.
All the built-in names can be seen used in menu.vim. All the built-in names can be seen used in menu.vim.
5) If all else fails, a blank, but functioning, button is displayed. - 5 If all else fails, a blank, but functioning, button is displayed.
*builtin-tools* *builtin-tools*
nr Name Normal action ~ >
00 New open new window nr Name Normal action
01 Open browse for file to open in current window 00 New open new window
02 Save write buffer to file 01 Open browse for file to open in current window
03 Undo undo last change 02 Save write buffer to file
04 Redo redo last undone change 03 Undo undo last change
05 Cut delete selected text to clipboard 04 Redo redo last undone change
06 Copy copy selected text to clipboard 05 Cut delete selected text to clipboard
07 Paste paste text from clipboard 06 Copy copy selected text to clipboard
08 Print print current buffer 07 Paste paste text from clipboard
09 Help open a buffer on Vim's builtin help 08 Print print current buffer
10 Find start a search command 09 Help open a buffer on Vim's builtin help
11 SaveAll write all modified buffers to file 10 Find start a search command
12 SaveSesn write session file for current situation 11 SaveAll write all modified buffers to file
13 NewSesn write new session file 12 SaveSesn write session file for current situation
14 LoadSesn load session file 13 NewSesn write new session file
15 RunScript browse for file to run as a Vim script 14 LoadSesn load session file
16 Replace prompt for substitute command 15 RunScript browse for file to run as a Vim script
17 WinClose close current window 16 Replace prompt for substitute command
18 WinMax make current window use many lines 17 WinClose close current window
19 WinMin make current window use few lines 18 WinMax make current window use many lines
20 WinSplit split current window 19 WinMin make current window use few lines
21 Shell start a shell 20 WinSplit split current window
22 FindPrev search again, backward 21 Shell start a shell
23 FindNext search again, forward 22 FindPrev search again, backward
24 FindHelp prompt for word to search help for 23 FindNext search again, forward
25 Make run make and jump to first error 24 FindHelp prompt for word to search help for
26 TagJump jump to tag under the cursor 25 Make run make and jump to first error
27 RunCtags build tags for files in current directory 26 TagJump jump to tag under the cursor
28 WinVSplit split current window vertically 27 RunCtags build tags for files in current directory
29 WinMaxWidth make current window use many columns 28 WinVSplit split current window vertically
30 WinMinWidth make current window use few columns 29 WinMaxWidth make current window use many columns
30 WinMinWidth make current window use few columns
*hidden-menus* *win32-hidden-menus* <
*hidden-menus* *win32-hidden-menus*
In the Win32 GUI, starting a menu name with ']' excludes that menu from the In the Win32 GUI, starting a menu name with ']' excludes that menu from the
main menu bar. You must then use the |:popup| command to display it. main menu bar. You must then use the |:popup| command to display it.
When splitting the window the window toolbar is not copied to the new window. When splitting the window the window toolbar is not copied to the new window.
*popup-menu* *popup-menu*
You can define the special menu "PopUp". This is the menu that is displayed 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 when the right mouse button is pressed, if 'mousemodel' is set to popup or
popup_setpos. popup_setpos.
@ -484,7 +486,7 @@ The default "PopUp" menu is: >vim
anoremenu PopUp.How-to\ disable\ mouse <Cmd>help disable-mouse<CR> anoremenu PopUp.How-to\ disable\ mouse <Cmd>help disable-mouse<CR>
< <
Showing What Menus Are Mapped To *showing-menus* Showing What Menus Are Mapped To *showing-menus*
To see what an existing menu is mapped to, use just one argument after the To see what an existing menu is mapped to, use just one argument after the
menu commands (just like you would with the ":map" commands). If the menu menu commands (just like you would with the ":map" commands). If the menu
@ -503,25 +505,25 @@ Note that hitting <Tab> while entering a menu name after a menu command may
be used to complete the name of the menu item. be used to complete the name of the menu item.
Executing Menus *execute-menus* Executing Menus *execute-menus*
*:em* *:emenu* *E334* *E335* *:em* *:emenu* *E334* *E335*
:[range]em[enu] {menu} Execute {menu} from the command line. :[range]em[enu] {menu} Execute {menu} from the command line.
The default is to execute the Normal mode The default is to execute the Normal mode
menu. If a range is specified, it executes menu. If a range is specified, it executes
the Visual mode menu. the Visual mode menu.
If used from <c-o>, it executes the If used from <c-o>, it executes the
insert-mode menu Eg: > insert-mode menu Eg: >
:emenu File.Exit :emenu File.Exit
:[range]em[enu] {mode} {menu} Like above, but execute the menu for {mode}: :[range]em[enu] {mode} {menu} Like above, but execute the menu for {mode}:
'n': |:nmenu| Normal mode - 'n': |:nmenu| Normal mode
'v': |:vmenu| Visual mode - 'v': |:vmenu| Visual mode
's': |:smenu| Select mode - 's': |:smenu| Select mode
'o': |:omenu| Operator-pending mode - 'o': |:omenu| Operator-pending mode
't': |:tlmenu| Terminal mode - 't': |:tlmenu| Terminal mode
'i': |:imenu| Insert mode - 'i': |:imenu| Insert mode
'c': |:cmenu| Cmdline mode - 'c': |:cmenu| Cmdline mode
You can use :emenu to access useful menu items you may have got used to from You can use :emenu to access useful menu items you may have got used to from
@ -532,10 +534,10 @@ When using a range, if the lines match with '<,'>, then the menu is executed
using the last visual selection. using the last visual selection.
Deleting Menus *delete-menus* Deleting Menus *delete-menus*
*:unme* *:unmenu* *:unme* *:unmenu*
*:aun* *:aunmenu* *:aun* *:aunmenu*
To delete a menu item or a whole submenu, use the unmenu commands, which are To delete a menu item or a whole submenu, use the unmenu commands, which are
analogous to the unmap commands. Eg: > analogous to the unmap commands. Eg: >
:unmenu! Edit.Paste :unmenu! Edit.Paste
@ -546,26 +548,26 @@ Command-line modes.
Note that hitting <Tab> while entering a menu name after an umenu command Note that hitting <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. may be used to complete the name of the menu item for the appropriate mode.
To remove all menus use: *:unmenu-all* > To remove all menus use: *:unmenu-all* >
:unmenu * " remove all menus in Normal and visual mode :unmenu * " remove all menus in Normal and visual mode
:unmenu! * " remove all menus in Insert and Command-line mode :unmenu! * " remove all menus in Insert and Command-line mode
:aunmenu * " remove all menus in all modes, except for Terminal :aunmenu * " remove all menus in all modes, except for Terminal
" mode " mode
:tlunmenu * " remove all menus in Terminal mode :tlunmenu * " remove all menus in Terminal mode
If you want to get rid of the menu bar: > If you want to get rid of the menu bar: >
:set guioptions-=m :set guioptions-=m
Disabling Menus *disable-menus* Disabling Menus *disable-menus*
*:menu-disable* *:menu-enable* *:menu-disable* *:menu-enable*
If you do not want to remove a menu, but disable it for a moment, this can be 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. done by adding the "enable" or "disable" keyword to a ":menu" command.
Examples: > Examples: >
:menu disable &File.&Open\.\.\. :menu disable &File.&Open\.\.\.
:amenu enable * :amenu enable *
:amenu disable &Tools.* :amenu disable &Tools.*
The command applies to the modes as used with all menu commands. Note that 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. characters like "&" need to be included for translated names to be found.
@ -573,36 +575,36 @@ When the argument is "*", all menus are affected. Otherwise the given menu
name and all existing submenus below it are affected. name and all existing submenus below it are affected.
Examples for Menus *menu-examples* Examples for Menus *menu-examples*
Here is an example on how to add menu items with menus! You can add a menu Here is an example on how to add menu items with menus! You can add a menu
item for the keyword under the cursor. The register "z" is used. > item for the keyword under the cursor. The register "z" is used. >
:nmenu Words.Add\ Var wb"zye:menu! Words.<C-R>z <C-R>z<CR> :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> :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.Add\ Var "zy:menu! Words.<C-R>z <C-R>z <CR>
:vmenu Words.Remove\ Var "zy:unmenu! Words.<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.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 :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 (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 mappings, or put these lines in your gvimrc; "<C-R>" is CTRL-R, "<CR>" is
the <CR> key. |<>|) the <CR> key. |<>|)
*tooltips* *menu-tips* *tooltips* *menu-tips*
Tooltips & Menu tips Tooltips & Menu tips
See section |42.4| in the user manual. See section |42.4| in the user manual.
*:tmenu* *:tmenu*
:tm[enu] {menupath} {rhs} Define a tip for a menu or tool. (only in :tm[enu] {menupath} {rhs} Define a tip for a menu or tool. (only in
X11 and Win32 GUI) X11 and Win32 GUI)
:tm[enu] [menupath] List menu tips. (only in X11 and Win32 GUI) :tm[enu] [menupath] List menu tips. (only in X11 and Win32 GUI)
*:tunmenu* *:tunmenu*
:tu[nmenu] {menupath} Remove a tip for a menu or tool. :tu[nmenu] {menupath} Remove a tip for a menu or tool.
(only in X11 and Win32 GUI) (only in X11 and Win32 GUI)
Note: To create menus for terminal mode, use |:tlmenu| instead. Note: To create menus for terminal mode, use |:tlmenu| instead.
@ -616,11 +618,11 @@ highlight group to change its colors.
A "tip" can be defined for each menu item. For example, when defining a menu A "tip" can be defined for each menu item. For example, when defining a menu
item like this: > item like this: >
:amenu MyMenu.Hello :echo "Hello"<CR> :amenu MyMenu.Hello :echo "Hello"<CR>
The tip is defined like this: > The tip is defined like this: >
:tmenu MyMenu.Hello Displays a greeting. :tmenu MyMenu.Hello Displays a greeting.
And delete it with: > And delete it with: >
:tunmenu MyMenu.Hello :tunmenu MyMenu.Hello
Tooltips are currently only supported for the X11 and Win32 GUI. However, they Tooltips 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. should appear for the other gui platforms in the not too distant future.
@ -639,24 +641,24 @@ a menu item - you don't need to do a :tunmenu as well.
You can cause a menu to popup at the cursor. This behaves similarly to the You can cause a menu to popup at the cursor. This behaves similarly to the
PopUp menus except that any menu tree can be popped up. PopUp menus except that any menu tree can be popped up.
*:popup* *:popu* *:popup* *:popu*
:popu[p] {name} Popup the menu {name}. The menu named must :popu[p] {name} Popup the menu {name}. The menu named must
have at least one subentry, but need not have at least one subentry, but need not
appear on the menu-bar (see |hidden-menus|). appear on the menu-bar (see |hidden-menus|).
:popu[p]! {name} Like above, but use the position of the mouse :popu[p]! {name} Like above, but use the position of the mouse
pointer instead of the cursor. pointer instead of the cursor.
Example: > Example: >
:popup File :popup File
will make the "File" menu (if there is one) appear at the text cursor (mouse will make the "File" menu (if there is one) appear at the text cursor (mouse
pointer if ! was used). > pointer if ! was used). >
:amenu ]Toolbar.Make :make<CR> :amenu ]Toolbar.Make :make<CR>
:popup ]Toolbar :popup ]Toolbar
This creates a popup menu that doesn't exist on the main menu-bar. This creates a popup menu that doesn't exist on the main menu-bar.
Note that a menu that starts with ']' will not be displayed. Note that a menu that starts with ']' will not be displayed.
vim:tw=78:sw=4:ts=8:noet:ft=help:norl: vim:tw=78:sw=4:ts=8:et:ft=help:norl:

20
runtime/doc/intro.txt
View File

@ -53,19 +53,33 @@ Nvim on the interwebs *internet*
- Nvim home page: https://neovim.io/ - Nvim home page: https://neovim.io/
- Vim FAQ: https://vimhelp.org/vim_faq.txt.html - Vim FAQ: https://vimhelp.org/vim_faq.txt.html
*download* *upgrade* *ubuntu* *download* *upgrade* *install* *ubuntu*
To install or upgrade Nvim, you can... To install or upgrade Nvim, you can...
- Download a pre-built archive: - Download a pre-built archive:
https://github.com/neovim/neovim/releases https://github.com/neovim/neovim/releases
- Use your system package manager: - Use your system package manager:
https://github.com/neovim/neovim/blob/master/INSTALL.md#install-from-package https://github.com/neovim/neovim/blob/master/INSTALL.md#install-from-package
- Build from source:
https://github.com/neovim/neovim/blob/master/INSTALL.md#install-from-source
*bugs* *bug-report* *feature-request* *bugs* *bug-report* *feature-request*
Report bugs and request features here: https://github.com/neovim/neovim/issues Report bugs and request features here: https://github.com/neovim/neovim/issues
Be brief, yet complete. Always give a reproducible example and try to find Be brief, yet complete. Always give a reproducible example and try to find
out which settings or other things trigger the bug. out which settings or other things trigger the bug. If Nvim crashed, try to
get a backtrace (see |dev-tools-backtrace|).
If Nvim crashes, try to get a backtrace. See |debug.txt|. *uninstall*
To un-install Nvim:
- If you downloaded a pre-built archive or built Nvim from source (e.g. `make
install`), just delete its files, typically located in: >
/usr/local/bin/nvim
/usr/local/share/nvim
<
- If you installed via package manager, read your package manager's
documentation. Common examples:
- APT (Debian, Ubuntu, …): `apt-get remove neovim`
- Homebrew (macOS): `brew install neovim`
- Scoop (Windows): `scoop install neovim`
============================================================================== ==============================================================================
Sponsor Vim/Nvim development *sponsor* *register* Sponsor Vim/Nvim development *sponsor* *register*

2
runtime/doc/provider.txt
View File

@ -193,7 +193,7 @@ registers. Nvim looks for these clipboard tools, in order of priority:
- xclip (if $DISPLAY is set) - xclip (if $DISPLAY is set)
- lemonade (for SSH) https://github.com/pocke/lemonade - lemonade (for SSH) https://github.com/pocke/lemonade
- doitclient (for SSH) https://www.chiark.greenend.org.uk/~sgtatham/doit/ - doitclient (for SSH) https://www.chiark.greenend.org.uk/~sgtatham/doit/
- win32yank (Windows) - *win32yank* (Windows)
- putclip, getclip (Windows) https://cygwin.com/packages/summary/cygutils.html - putclip, getclip (Windows) https://cygwin.com/packages/summary/cygutils.html
- clip, powershell (Windows) https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/clip - clip, powershell (Windows) https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/clip
- termux (via termux-clipboard-set, termux-clipboard-set) - termux (via termux-clipboard-set, termux-clipboard-set)

2
runtime/doc/sign.txt
View File

@ -10,7 +10,7 @@ Sign Support Features *sign-support*
Type |gO| to see the table of contents. Type |gO| to see the table of contents.
============================================================================== ==============================================================================
1. Introduction *sign-intro* *signs* 1. Introduction *sign-intro* *signs* *gutter*
When a debugger or other IDE tool is driving an editor it needs to be able When a debugger or other IDE tool is driving an editor it needs to be able
to give specific highlights which quickly tell the user useful information to give specific highlights which quickly tell the user useful information

1
scripts/gen_help_html.lua
View File

@ -70,6 +70,7 @@ local new_layout = {
['dev_vimpatch.txt'] = true, ['dev_vimpatch.txt'] = true,
['editorconfig.txt'] = true, ['editorconfig.txt'] = true,
['faq.txt'] = true, ['faq.txt'] = true,
['gui.txt'] = true,
['lua.txt'] = true, ['lua.txt'] = true,
['luaref.txt'] = true, ['luaref.txt'] = true,
['news.txt'] = true, ['news.txt'] = true,