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

doc: *Terminal-mode* #6757

Browse Source 
Closes #6756
This commit is contained in:
Drew Neil
2017-05-16 16:19:12 +01:00
committed by Justin M. Keyes
parent 7b55d50bbd
commit 620df53860
3 changed files with 19 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
runtime/doc/intro.txt
View File

@@ -489,7 +489,7 @@ examples and use them directly. Or type them literally, including the '<' and
============================================================================== ==============================================================================
5. Modes, introduction *vim-modes-intro* *vim-modes* 5. Modes, introduction *vim-modes-intro* *vim-modes*
Vim has six BASIC modes: Vim has seven BASIC modes:
*Normal* *Normal-mode* *command-mode* *Normal* *Normal-mode* *command-mode*
Normal mode In Normal mode you can enter all the normal editor Normal mode In Normal mode you can enter all the normal editor
@@ -525,6 +525,13 @@ Ex mode Like Command-line mode, but after entering a command
you remain in Ex mode. Very limited editing of the you remain in Ex mode. Very limited editing of the
command line. |Ex-mode| command line. |Ex-mode|
*Terminal-mode*
Terminal mode In Terminal mode all input (except |c_CTRL-\_CTRL-N|)
is sent to the process running in the current
|terminal| buffer.
If the 'showmode' option is on "-- TERMINAL --" is shown
at the bottom of the window.
There are six ADDITIONAL modes. These are variants of the BASIC modes: There are six ADDITIONAL modes. These are variants of the BASIC modes:
*Operator-pending* *Operator-pending-mode* *Operator-pending* *Operator-pending-mode*

3
runtime/doc/nvim_terminal_emulator.txt
View File

@@ -5,6 +5,7 @@
Terminal emulator *terminal-emulator* Terminal emulator *terminal-emulator*
*terminal-buffer*
Nvim embeds a VT220/xterm terminal emulator based on libvterm. The terminal is Nvim embeds a VT220/xterm terminal emulator based on libvterm. The terminal is
presented as a special buffer type, asynchronously updated from the virtual presented as a special buffer type, asynchronously updated from the virtual
@@ -43,7 +44,7 @@ restarting the {cmd} when the session is loaded.
============================================================================== ==============================================================================
Input *terminal-emulator-input* Input *terminal-emulator-input*
To send input, enter terminal-mode using any command that would enter "insert To send input, enter |Terminal-mode| using any command that would enter "insert
mode" in a normal buffer, such as |i| or |:startinsert|. In this mode all keys mode" in a normal buffer, such as |i| or |:startinsert|. In this mode all keys
except <C-\><C-N> are sent to the underlying program. Use <C-\><C-N> to return except <C-\><C-N> are sent to the underlying program. Use <C-\><C-N> to return
to normal-mode. |CTRL-\_CTRL-N| to normal-mode. |CTRL-\_CTRL-N|

13
runtime/doc/various.txt
View File

@@ -208,15 +208,20 @@ g8 Print the hex values of the bytes used in the
:sh[ell] Removed. |vim-differences| {Nvim} :sh[ell] Removed. |vim-differences| {Nvim}
*:terminal* *:te* *:terminal* *:te*
:te[rminal][!] {cmd} Execute {cmd} with 'shell' in a |terminal-emulator| :te[rminal][!] [{cmd}] Execute {cmd} with 'shell' in a new |terminal| buffer.
buffer. Equivalent to: > Equivalent to: >
:enew :enew
:call termopen('{cmd}') :call termopen('{cmd}')
:startinsert :startinsert
< <
See |jobstart()|. See |termopen()|.
To enter terminal mode automatically: > Without {cmd}, start an interactive shell.
Creating the terminal buffer fails when changes have been
made to the current buffer, unless 'hidden' is set.
To enter |Terminal-mode| automatically: >
autocmd BufEnter term://* startinsert autocmd BufEnter term://* startinsert
autocmd BufLeave term://* stopinsert autocmd BufLeave term://* stopinsert
< <