mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-06 03:18:16 +00: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
parent 8323398bc6 5413c6475e
commit 845e563421
5 changed files with 249 additions and 232 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
runtime/doc/gui.txt
View File

@@ -226,14 +226,15 @@ tooltips for menus. See |terminal-input|.
Special characters in a menu name:
*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 "&&".
- & 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!
- <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>
@@ -246,14 +247,14 @@ 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:
mode inserted appended ~
automatically inserted for some modes: >
mode inserted appended
Normal nothing nothing
Visual <C-C> <C-\><C-G>
Insert <C-\><C-O>
Cmdline <C-C> <C-\><C-G>
Op-pending <C-C> <C-\><C-G>
<
Example: >
:amenu File.Next :next^M
@@ -327,7 +328,7 @@ 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:
The default menus have these priorities: >
File 10
Edit 20
Tools 40
@@ -335,7 +336,7 @@ The default menus have these priorities:
Buffers 60
Window 70
Help 9999
<
When no or zero priority is given, 500 is used.
The priority for the PopUp menu is not used.
@@ -386,7 +387,7 @@ 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.
- 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: >
@@ -398,11 +399,11 @@ level. Vim interprets the items in this menu as follows:
A space in the file name must be escaped with a backslash.
A menu priority must come _after_ the icon argument: >
: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
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
- 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 >
@@ -414,16 +415,17 @@ level. Vim interprets the items in this menu as follows:
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,
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.
So the command >
:amenu ToolBar.Open :e
< 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.
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*
nr Name Normal action ~
>
nr Name Normal action
00 New open new window
01 Open browse for file to open in current window
02 Save write buffer to file
@@ -455,7 +457,7 @@ nr Name Normal action ~
28 WinVSplit split current window vertically
29 WinMaxWidth make current window use many columns
30 WinMinWidth make current window use few columns
<
*hidden-menus* *win32-hidden-menus*
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.
@@ -515,13 +517,13 @@ Executing Menus *execute-menus*
: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 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 mode
You can use :emenu to access useful menu items you may have got used to from
@@ -659,4 +661,4 @@ 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.
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/
- Vim FAQ: https://vimhelp.org/vim_faq.txt.html
*download* *upgrade* *ubuntu*
*download* *upgrade* *install* *ubuntu*
To install or upgrade Nvim, you can...
- Download a pre-built archive:
https://github.com/neovim/neovim/releases
- Use your system package manager:
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*
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
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*

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)
- lemonade (for SSH) https://github.com/pocke/lemonade
- 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
- clip, powershell (Windows) https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/clip
- 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.
==============================================================================
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
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,
['editorconfig.txt'] = true,
['faq.txt'] = true,
['gui.txt'] = true,
['lua.txt'] = true,
['luaref.txt'] = true,
['news.txt'] = true,