Mercurial > vim
diff runtime/doc/channel.txt @ 11763:21f3930dfe6e
Documentation updates.
commit https://github.com/vim/vim/commit/b6e0ec6b71c45284d94f51728dbc33e5d3428ff4
Author: Bram Moolenaar <Bram@vim.org>
Date: Sun Jul 23 22:12:20 2017 +0200
Documentation updates.
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Sun, 23 Jul 2017 22:15:06 +0200 |
| parents | 49c12c93abf3 |
| children | 2796a2c9fc17 |
line wrap: on
line diff
--- 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_setoption "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_setoption 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_setoption 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_setoption 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)