mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-12-08 23:52:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: graduate tui.txt to "flow layout" #30413

Browse Source
This commit is contained in:
Justin M. Keyes
2024-09-18 01:28:00 -07:00
committed by GitHub
parent 83a7d97d64
commit 22553e1f38
2 changed files with 117 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
runtime/doc/tui.txt
View File

@@ -41,6 +41,7 @@ or sub-optimal behavior will result (scrolling quirks, wrong colors, etc.).
$TERM is also important because it is forwarded by SSH to the remote session, $TERM is also important because it is forwarded by SSH to the remote session,
unlike most other environment variables. unlike most other environment variables.
>
For this terminal Set $TERM to |builtin-terms| For this terminal Set $TERM to |builtin-terms|
------------------------------------------------------------------------- -------------------------------------------------------------------------
anything libvte-based vte, vte-256color Y anything libvte-based vte, vte-256color Y
@@ -61,6 +62,7 @@ unlike most other environment variables.
Windows/VTP console vtpcon Y Windows/VTP console vtpcon Y
Windows/legacy console win32con Y Windows/legacy console win32con Y
xterm or compatible xterm, xterm-256color Y xterm or compatible xterm, xterm-256color Y
<
*builtin-terms* *builtin_terms* *builtin-terms* *builtin_terms*
If a |terminfo| database is not available or there is no entry for the current If a |terminfo| database is not available or there is no entry for the current
@@ -216,7 +218,7 @@ are not in terminfo you must add them by setting "terminal-overrides" in
See the tmux(1) manual page for the details of how and what to do in the tmux See the tmux(1) manual page for the details of how and what to do in the tmux
configuration file. It will look something like: >bash configuration file. It will look something like: >bash
set -ga terminal-overrides '*:Ss=\E[%p1%d q:Se=\E[ q' set -ga terminal-overrides '*:Ss=\E[%p1%d q:Se=\E[ q'
<or (alas!) for Konsole 18.07.70 or older, something more complex like: >bash or (alas!) for Konsole 18.07.70 or older, something more complex like: >bash
set -ga terminal-overrides 'xterm*:\E]50;CursorShape=%?%p1%{3}%<%t%{0}%e%{1}%;%d\007' set -ga terminal-overrides 'xterm*:\E]50;CursorShape=%?%p1%{3}%<%t%{0}%e%{1}%;%d\007'
< <
============================================================================== ==============================================================================
@@ -250,7 +252,6 @@ number of lines that Vim uses with the command "z{height}<CR>".
If the characters from the terminal are arriving with more than 1 second If the characters from the terminal are arriving with more than 1 second
between them you might want to set the 'timeout' and/or 'ttimeout' option. between them you might want to set the 'timeout' and/or 'ttimeout' option.
See the "Options" chapter |options|.
If you are using a color terminal that is slow when displaying lines beyond If you are using a color terminal that is slow when displaying lines beyond
the end of a buffer, this is because Nvim is drawing the whitespace twice, in the end of a buffer, this is because Nvim is drawing the whitespace twice, in
@@ -268,26 +269,30 @@ Using the mouse *mouse-using*
*mouse-mode-table* *mouse-overview* *mouse-mode-table* *mouse-overview*
Overview of what the mouse buttons do, when 'mousemodel' is "extend": Overview of what the mouse buttons do, when 'mousemodel' is "extend":
Normal Mode: *<S-LeftMouse>* *<A-RightMouse>* *<S-RightMouse>* *<RightDrag>*
event position selection change action ~ *<RightRelease>* *<LeftDrag>*
cursor window ~ Normal Mode: >
event position selection change action
cursor window
---------------------------------------------------------------------------
<LeftMouse> yes end yes <LeftMouse> yes end yes
<C-LeftMouse> yes end yes "CTRL-]" (2) <C-LeftMouse> yes end yes "CTRL-]" (2)
<S-LeftMouse> yes no change yes "*" (2) *<S-LeftMouse>* <S-LeftMouse> yes no change yes "*" (2)
<LeftDrag> yes start or extend (1) no *<LeftDrag>* <LeftDrag> yes start or extend (1) no
<LeftRelease> yes start or extend (1) no <LeftRelease> yes start or extend (1) no
<MiddleMouse> yes if not active no put <MiddleMouse> yes if not active no put
<MiddleMouse> yes if active no yank and put <MiddleMouse> yes if active no yank and put
<RightMouse> yes start or extend yes <RightMouse> yes start or extend yes
<A-RightMouse> yes start or extend blockw. yes *<A-RightMouse>* <A-RightMouse> yes start or extend blockw. yes
<S-RightMouse> yes no change yes "#" (2) *<S-RightMouse>* <S-RightMouse> yes no change yes "#" (2)
<C-RightMouse> no no change no "CTRL-T" <C-RightMouse> no no change no "CTRL-T"
<RightDrag> yes extend no *<RightDrag>* <RightDrag> yes extend no
<RightRelease> yes extend no *<RightRelease>* <RightRelease> yes extend no
Insert or Replace Mode: Insert or Replace Mode: >
event position selection change action ~ event position selection change action
cursor window ~ cursor window
---------------------------------------------------------------------------
<LeftMouse> yes (cannot be active) yes <LeftMouse> yes (cannot be active) yes
<C-LeftMouse> yes (cannot be active) yes "CTRL-O^]" (2) <C-LeftMouse> yes (cannot be active) yes "CTRL-O^]" (2)
<S-LeftMouse> yes (cannot be active) yes "CTRL-O*" (2) <S-LeftMouse> yes (cannot be active) yes "CTRL-O*" (2)
@@ -299,25 +304,29 @@ event position selection change action ~
<S-RightMouse> yes (cannot be active) yes "CTRL-O#" (2) <S-RightMouse> yes (cannot be active) yes "CTRL-O#" (2)
<C-RightMouse> no (cannot be active) no "CTRL-O CTRL-T" <C-RightMouse> no (cannot be active) no "CTRL-O CTRL-T"
In a help window: In a help window: >
event position selection change action ~ event position selection change action
cursor window ~ cursor window
---------------------------------------------------------------------------
<2-LeftMouse> yes (cannot be active) no "^]" (jump to help tag) <2-LeftMouse> yes (cannot be active) no "^]" (jump to help tag)
When 'mousemodel' is "popup", these are different: When 'mousemodel' is "popup", these are different:
Normal Mode: *<A-LeftMouse>*
event position selection change action ~ Normal Mode: >
cursor window ~ event position selection change action
cursor window
---------------------------------------------------------------------------
<S-LeftMouse> yes start or extend (1) no <S-LeftMouse> yes start or extend (1) no
<A-LeftMouse> yes start or extend blockw. no *<A-LeftMouse>* <A-LeftMouse> yes start/extend blockw no
<RightMouse> no popup menu no <RightMouse> no popup menu no
Insert or Replace Mode: Insert or Replace Mode: >
event position selection change action ~ event position selection change action
cursor window ~ cursor window
---------------------------------------------------------------------------
<S-LeftMouse> yes start or extend (1) no like CTRL-O (1) <S-LeftMouse> yes start or extend (1) no like CTRL-O (1)
<A-LeftMouse> yes start or extend blockw. no <A-LeftMouse> yes start/extend blockw no
<RightMouse> no popup menu no <RightMouse> no popup menu no
(1) only if mouse pointer moved since press (1) only if mouse pointer moved since press
@@ -348,16 +357,20 @@ key pressed causes the Visual area to become blockwise. When 'mousemodel' is
work on systems where the window manager consumes the mouse events when the work on systems where the window manager consumes the mouse events when the
alt key is pressed (it may move the window). alt key is pressed (it may move the window).
*double-click* *double-click* *<2-LeftMouse>* *<3-LeftMouse>* *<4-LeftMouse>*
Double, triple and quadruple clicks are supported when the GUI is active, for Double, triple and quadruple clicks are supported when the GUI is active, for
Win32 and for an xterm. For selecting text, extra clicks extend the Win32 and for an xterm. For selecting text, extra clicks extend the
selection: selection: >
click select ~
double word or % match *<2-LeftMouse>* click select
triple line *<3-LeftMouse>* ---------------------------------
quadruple rectangular block *<4-LeftMouse>* double word or % match
triple line
quadruple rectangular block
Exception: In a Help window a double click jumps to help for the word that is Exception: In a Help window a double click jumps to help for the word that is
clicked on. clicked on.
A double click on a word selects that word. 'iskeyword' is used to specify A double click on a word selects that word. 'iskeyword' is used to specify
which characters are included in a word. A double click on a character which characters are included in a word. A double click on a character
that has a match selects until that match (like using "v%"). If the match is that has a match selects until that match (like using "v%"). If the match is
@@ -379,9 +392,12 @@ temporarily. When Visual or Select mode ends, it returns to Insert mode.
This is like using CTRL-O in Insert mode. Select mode is used when the This is like using CTRL-O in Insert mode. Select mode is used when the
'selectmode' option contains "mouse". 'selectmode' option contains "mouse".
*X1Mouse* *X1Drag* *X1Release*
*X2Mouse* *X2Drag* *X2Release*
*<MiddleRelease>* *<MiddleDrag>* *<MiddleRelease>* *<MiddleDrag>*
Mouse clicks can be mapped. The codes for mouse clicks are: Mouse clicks can be mapped. The codes for mouse clicks are: >
code mouse button normal action ~ code mouse button normal action
---------------------------------------------------------------------------
<LeftMouse> left pressed set cursor position <LeftMouse> left pressed set cursor position
<LeftDrag> left moved while pressed extend selection <LeftDrag> left moved while pressed extend selection
<LeftRelease> left released set selection end <LeftRelease> left released set selection end
@@ -391,12 +407,12 @@ Mouse clicks can be mapped. The codes for mouse clicks are:
<RightMouse> right pressed extend selection <RightMouse> right pressed extend selection
<RightDrag> right moved while pressed extend selection <RightDrag> right moved while pressed extend selection
<RightRelease> right released set selection end <RightRelease> right released set selection end
<X1Mouse> X1 button pressed - *X1Mouse* <X1Mouse> X1 button pressed -
<X1Drag> X1 moved while pressed - *X1Drag* <X1Drag> X1 moved while pressed -
<X1Release> X1 button release - *X1Release* <X1Release> X1 button release -
<X2Mouse> X2 button pressed - *X2Mouse* <X2Mouse> X2 button pressed -
<X2Drag> X2 moved while pressed - *X2Drag* <X2Drag> X2 moved while pressed -
<X2Release> X2 button release - *X2Release* <X2Release> X2 button release -
The X1 and X2 buttons refer to the extra buttons found on some mice. The The X1 and X2 buttons refer to the extra buttons found on some mice. The
'Microsoft Explorer' mouse has these buttons available to the right thumb. 'Microsoft Explorer' mouse has these buttons available to the right thumb.
@@ -434,4 +450,4 @@ To swap the meaning of the left and right mouse buttons: >vim
:noremap! <RightDrag> <LeftDrag> :noremap! <RightDrag> <LeftDrag>
:noremap! <RightRelease> <LeftRelease> :noremap! <RightRelease> <LeftRelease>
< <
vim:tw=78:ts=8:ft=help:norl: vim:et:sw=2:tw=78:ts=8:ft=help:norl:

1
scripts/gen_help_html.lua
View File

@@ -76,6 +76,7 @@ local new_layout = {
['news-0.10.txt'] = true, ['news-0.10.txt'] = true,
['nvim.txt'] = true, ['nvim.txt'] = true,
['provider.txt'] = true, ['provider.txt'] = true,
['tui.txt'] = true,
['ui.txt'] = true, ['ui.txt'] = true,
['vim_diff.txt'] = true, ['vim_diff.txt'] = true,
} }