aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/nvim_terminal_emulator.txt
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/doc/nvim_terminal_emulator.txt')
-rw-r--r--runtime/doc/nvim_terminal_emulator.txt10
1 files changed, 8 insertions, 2 deletions
diff --git a/runtime/doc/nvim_terminal_emulator.txt b/runtime/doc/nvim_terminal_emulator.txt
index 45695ccf02..4296ef6490 100644
--- a/runtime/doc/nvim_terminal_emulator.txt
+++ b/runtime/doc/nvim_terminal_emulator.txt
@@ -33,9 +33,15 @@ There are 3 ways to create a terminal buffer:
- By editing a file with a name matching `term://(.{-}//(\d+:)?)?\zs.*`.
For example:
>
- :e term://bash
- :vsp term://top
+ :edit term://bash
+ :vsplit term://top
<
+ Note: The "term://" pattern is handled by a BufReadCmd handler, so the
+ |autocmd-nested| modifier is required to use it in an autocmd. >
+ autocmd VimEnter * nested split term://sh
+< This is only mentioned for reference; you should use the |:terminal|
+ command instead.
+
When the terminal spawns the program, the buffer will start to mirror the
terminal display and change its name to `term://$CWD//$PID:$COMMAND`.
Note that |:mksession| will "save" the terminal buffers by restarting all