kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-20 03:05:11 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update terminal documentation for clarity

Browse Source 
A couple lines tripped me up while reading through this document for the first
time. This change aims to reword/rework these areas, so that they are clearer
on the first read.
This commit is contained in:
Steve Robbibaro 2015-10-30 16:22:43 -04:00
parent d1cfaa0a55
commit cd67c3bacd
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
runtime/doc/nvim_terminal_emulator.txt
View File

@ -62,8 +62,8 @@ with the terminal. For example, here's how to map <Esc> to exit terminal mode:
:tnoremap <Esc> <C-\><C-n> :tnoremap <Esc> <C-\><C-n>
< <
Navigating to other windows is only possible by exiting to normal mode, which Navigating to other windows is only possible by exiting to normal mode, which
can be cumbersome with <C-\><C-n> keys. Here are some mappings to improve can be cumbersome with <C-\><C-n> keys. To improve the navigation experience,
the navigation experience: you could use the following mappings:
> >
:tnoremap <A-h> <C-\><C-n><C-w>h :tnoremap <A-h> <C-\><C-n><C-w>h
:tnoremap <A-j> <C-\><C-n><C-w>j :tnoremap <A-j> <C-\><C-n><C-w>j
@ -74,8 +74,9 @@ the navigation experience:
:nnoremap <A-k> <C-w>k :nnoremap <A-k> <C-w>k
:nnoremap <A-l> <C-w>l :nnoremap <A-l> <C-w>l
< <
This allows using `Alt+{h,j,k,l}` to navigate between windows no matter if This configuration allows using `Alt+{h,j,k,l}` to navigate between windows no
they are displaying a normal buffer or a terminal buffer in terminal mode. matter if they are displaying a normal buffer or a terminal buffer in terminal
mode.
Mouse input is also fully supported, and has the following behavior: Mouse input is also fully supported, and has the following behavior:
@ -97,8 +98,8 @@ variables (set via the |TermOpen| autocmd):
- `{g,b}:terminal_scrollback_buffer_size`: Scrollback buffer size, between 1 - `{g,b}:terminal_scrollback_buffer_size`: Scrollback buffer size, between 1
and 100000 inclusive. The default is 1000. and 100000 inclusive. The default is 1000.
- `{g,b}:terminal_color_$NUM`: The terminal color palette, where `$NUM` is the - `{g,b}:terminal_color_$NUM`: The terminal color palette, where `$NUM` is the
color index, between 0 and 255 inclusive. This only affects UIs with RGB color index, between 0 and 255 inclusive. This setting only affects UIs with
capabilities; for normal terminals the color index is simply forwarded. RGB capabilities; for normal terminals the color index is simply forwarded.
The configuration variables are only processed when the terminal starts, which The configuration variables are only processed when the terminal starts, which
is why it needs to be done with the |TermOpen| autocmd or setting global is why it needs to be done with the |TermOpen| autocmd or setting global