diff options
| author | Michael Reed <Pyrohh@users.noreply.github.com> | 2015-10-31 13:45:45 -0400 |
|---|---|---|
| committer | Michael Reed <Pyrohh@users.noreply.github.com> | 2015-10-31 13:45:45 -0400 |
| commit | 48f67d3816a73f7a43a60f735acbba674fefe7b0 (patch) | |
| tree | 26bf8415af4fd4e309b0850a2622fd4b1799a538 | |
| parent | 0dac6660985dee7c5515b9b5a91e4ed66d151bc2 (diff) | |
| parent | cd67c3bacd6bda0603fc4bb490c4dcab0c5adf00 (diff) | |
| download | rneovim-48f67d3816a73f7a43a60f735acbba674fefe7b0.tar.gz rneovim-48f67d3816a73f7a43a60f735acbba674fefe7b0.tar.bz2 rneovim-48f67d3816a73f7a43a60f735acbba674fefe7b0.zip | |
Merge pull request #3570 from srobbibaro/srobbibaro/doc-update
[RFC] Update terminal documentation for clarity
| -rw-r--r-- | runtime/doc/nvim_terminal_emulator.txt | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/runtime/doc/nvim_terminal_emulator.txt b/runtime/doc/nvim_terminal_emulator.txt index 850391200e..701c6dc274 100644 --- a/runtime/doc/nvim_terminal_emulator.txt +++ b/runtime/doc/nvim_terminal_emulator.txt @@ -62,8 +62,8 @@ with the terminal. For example, here's how to map <Esc> to exit terminal mode: :tnoremap <Esc> <C-\><C-n> < 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 -the navigation experience: +can be cumbersome with <C-\><C-n> keys. To improve the navigation experience, +you could use the following mappings: > :tnoremap <A-h> <C-\><C-n><C-w>h :tnoremap <A-j> <C-\><C-n><C-w>j @@ -74,8 +74,9 @@ the navigation experience: :nnoremap <A-k> <C-w>k :nnoremap <A-l> <C-w>l < -This allows using `Alt+{h,j,k,l}` to navigate between windows no matter if -they are displaying a normal buffer or a terminal buffer in terminal mode. +This configuration allows using `Alt+{h,j,k,l}` to navigate between windows no +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: @@ -97,8 +98,8 @@ variables (set via the |TermOpen| autocmd): - `{g,b}:terminal_scrollback_buffer_size`: Scrollback buffer size, between 1 and 100000 inclusive. The default is 1000. - `{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 - capabilities; for normal terminals the color index is simply forwarded. + color index, between 0 and 255 inclusive. This setting only affects UIs with + RGB capabilities; for normal terminals the color index is simply forwarded. 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 |