aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/eval.txt20
-rw-r--r--runtime/doc/various.txt15
2 files changed, 22 insertions, 13 deletions
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 0284e6cab8..f151fd84ba 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -6299,15 +6299,17 @@ tempname() *tempname()* *temp-file-name*
For MS-Windows forward slashes are used when the 'shellslash'
option is set or when 'shellcmdflag' starts with '-'.
-termopen({command}[, {opts}]) {Nvim} *termopen()*
- Spawns {command} using the shell in a new pseudo-terminal
- session connected to the current buffer. This function fails
- if the current buffer is modified (all buffer contents are
- destroyed). The {opts} dict is similar to the one passed to
- |jobstart()|, but the `pty`, `width`, `height`, and `TERM` fields are
- ignored: `height`/`width` are taken from the current window and
- $TERM is set to "xterm-256color". Returns the same values as
- |jobstart()|.
+termopen({argv}[, {opts}]) {Nvim} *termopen()*
+ Spawns {argv}(list) in a new pseudo-terminal session connected
+ to the current buffer. This function fails if the current
+ buffer is modified (all buffer contents are destroyed).
+
+ The {opts} dict is similar to the one passed to |jobstart()|,
+ but the `pty`, `width`, `height`, and `TERM` fields are
+ ignored: `height`/`width` are taken from the current window
+ and `$TERM` is set to "xterm-256color". An additional option,
+ `name`, can be used to give the terminal a specific name.
+ Returns the same values as |jobstart()|.
See |nvim-terminal-emulator| for more information.
diff --git a/runtime/doc/various.txt b/runtime/doc/various.txt
index 8ddfdf272f..13bc089824 100644
--- a/runtime/doc/various.txt
+++ b/runtime/doc/various.txt
@@ -223,11 +223,18 @@ g8 Print the hex values of the bytes used in the
:sh[ell] Removed. |vim-differences| {Nvim}
*:term* *:terminal*
-:term[inal][!] {cmd} Spawns {command} using the current value of 'shell'
- in a new terminal buffer. This is equivalent to: >
-
- :enew | call termopen('{cmd}') | startinsert
+:term[inal][!] {cmd} Spawns {cmd} using the current value of 'shell' and
+ 'shellcmdflag' in a new terminal buffer. This is
+ equivalent to: >
+
+ :enew
+ :call termopen([&sh, &shcf, '{cmd}'],
+ \{'name':'{cmd}'})
+ :startinsert
<
+ If no {cmd} is given, 'shellcmdflag' will not be sent
+ to |termopen()|.
+
Like |:enew|, it will fail if the current buffer is
modified, but can be forced with "!". See |termopen()|
and |nvim-terminal-emulator| for more information.