summaryrefslogtreecommitdiffstats
path: root/runtime/doc/channel.txt
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2017-07-23 22:12:20 +0200
committerBram Moolenaar <Bram@vim.org>2017-07-23 22:12:20 +0200
commitb6e0ec6b71c45284d94f51728dbc33e5d3428ff4 (patch)
treef8705d9d37901839d23ca8c47ea71899e2d7c613 /runtime/doc/channel.txt
parent9cc5f75932b10f611d8b3f444d025053f9dbcab1 (diff)
Documentation updates.
Diffstat (limited to 'runtime/doc/channel.txt')
-rw-r--r--runtime/doc/channel.txt20
1 files changed, 13 insertions, 7 deletions
diff --git a/runtime/doc/channel.txt b/runtime/doc/channel.txt
index 5bcf950406..f85c15022e 100644
--- a/runtime/doc/channel.txt
+++ b/runtime/doc/channel.txt
@@ -1,4 +1,4 @@
-*channel.txt* For Vim version 8.0. Last change: 2017 Jun 11
+*channel.txt* For Vim version 8.0. Last change: 2017 Jul 22
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -611,7 +611,7 @@ See |job_setoptions()| and |ch_setoptions()|.
"close_cb": handler Callback for when the channel is closed. Same as
"close_cb" on |ch_open()|, see |close_cb|.
*job-drop*
-"drop" Specifies when to drop messages. Same as "drop" on
+"drop": when Specifies when to drop messages. Same as "drop" on
|ch_open()|, see |channel-drop|. For "auto" the
exit_cb is not considered.
*job-exit_cb*
@@ -624,12 +624,12 @@ See |job_setoptions()| and |ch_setoptions()|.
Note that data can be buffered, callbacks may still be
called after the process ends.
*job-timeout*
-"timeout" The time to wait for a request when blocking, E.g.
+"timeout": time The time to wait for a request when blocking, E.g.
when using ch_evalexpr(). In milliseconds. The
default is 2000 (2 seconds).
*out_timeout* *err_timeout*
-"out_timeout" Timeout for stdout. Only when using pipes.
-"err_timeout" Timeout for stderr. Only when using pipes.
+"out_timeout": time Timeout for stdout. Only when using pipes.
+"err_timeout": time Timeout for stderr. Only when using pipes.
Note: when setting "timeout" the part specific mode is
overwritten. Therefore set "timeout" first and the
part specific mode later.
@@ -641,8 +641,9 @@ See |job_setoptions()| and |ch_setoptions()|.
The default is "term".
*job-term*
-"term": "open" Start a terminal and connect the job
- stdin/stdout/stderr to it.
+"term": "open" Start a terminal in a new window and connect the job
+ stdin/stdout/stderr to it. Similar to using
+ `:terminal`.
NOTE: Not implemented yet!
"channel": {channel} Use an existing channel instead of creating a new one.
@@ -652,6 +653,11 @@ See |job_setoptions()| and |ch_setoptions()|.
cause I/O errors.
Existing callbacks and other settings remain.
+"pty": 1 Use a pty (pseudo-tty) instead of a pipe when
+ possible. This is most useful in combination with a
+ terminal window, see |terminal|.
+ {only on Unix and Unix-like systems}
+
*job-in_io* *in_top* *in_bot* *in_name* *in_buf*
"in_io": "null" disconnect stdin (read from /dev/null)
"in_io": "pipe" stdin is connected to the channel (default)