diff options
| author | Saúl Ibarra Corretgé <saghul@gmail.com> | 2015-01-07 09:38:20 +0100 |
|---|---|---|
| committer | Saúl Ibarra Corretgé <saghul@gmail.com> | 2015-01-07 13:58:55 +0100 |
| commit | 85d662476847f0e96767a27cb5166a7233200aa4 (patch) | |
| tree | 6f62f2f36b8ee778039739a892273c86ce89bbd4 /docs/src | |
| parent | 72e4b5ab662e66f5931354a3519fbb5682382b15 (diff) | |
| download | libuv-85d662476847f0e96767a27cb5166a7233200aa4.tar.gz libuv-85d662476847f0e96767a27cb5166a7233200aa4.zip | |
doc: clarify the behavior of uv_tty_init
Closes #120
PR-URL: https://github.com/libuv/libuv/pull/121
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/tty.rst | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/src/tty.rst b/docs/src/tty.rst index 74b48594..6c20c84b 100644 --- a/docs/src/tty.rst +++ b/docs/src/tty.rst @@ -58,8 +58,13 @@ API `readable`, specifies if you plan on calling :c:func:`uv_read_start` with this stream. stdin is readable, stdout is not. + On Unix this function will try to open ``/dev/tty`` and use it if the passed file + descriptor refers to a TTY. This lets libuv put the tty in non-blocking mode + without affecting other processes that share the tty. + .. note:: - TTY streams which are not readable have blocking writes. + If opening ``/dev/tty`` fails, libuv falls back to blocking writes for non-readable + TTY streams. .. c:function:: int uv_tty_set_mode(uv_tty_t*, uv_tty_mode_t mode) |