gre-ilya/libuv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: fix long lines in tty.rst

Browse Source 
PR-URL: https://github.com/libuv/libuv/pull/259
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
This commit is contained in:
Ben Noordhuis 2015-03-11 14:36:12 +01:00
parent 531b08555d
commit 868700952b
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/src/tty.rst
View File

@ -24,14 +24,14 @@ Data types
:: ::
typedef enum { typedef enum {
/* Initial/normal terminal mode */ /* Initial/normal terminal mode */
UV_TTY_MODE_NORMAL, UV_TTY_MODE_NORMAL,
/* Raw input mode (On Windows, ENABLE_WINDOW_INPUT is also enabled) */ /* Raw input mode (On Windows, ENABLE_WINDOW_INPUT is also enabled) */
UV_TTY_MODE_RAW, UV_TTY_MODE_RAW,
/* Binary-safe I/O mode for IPC (Unix-only) */ /* Binary-safe I/O mode for IPC (Unix-only) */
UV_TTY_MODE_IO UV_TTY_MODE_IO
} uv_tty_mode_t; } uv_tty_mode_t;
@ -58,18 +58,18 @@ API
`readable`, specifies if you plan on calling :c:func:`uv_read_start` with `readable`, specifies if you plan on calling :c:func:`uv_read_start` with
this stream. stdin is readable, stdout is not. 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 On Unix this function will try to open ``/dev/tty`` and use it if the passed
descriptor refers to a TTY. This lets libuv put the tty in non-blocking mode file descriptor refers to a TTY. This lets libuv put the tty in non-blocking
without affecting other processes that share the tty. mode without affecting other processes that share the tty.
.. note:: .. note::
If opening ``/dev/tty`` fails, libuv falls back to blocking writes for non-readable If opening ``/dev/tty`` fails, libuv falls back to blocking writes for
TTY streams. non-readable TTY streams.
.. c:function:: int uv_tty_set_mode(uv_tty_t*, uv_tty_mode_t mode) .. c:function:: int uv_tty_set_mode(uv_tty_t*, uv_tty_mode_t mode)
.. versionchanged:: 1.2.0: the mode is specified as a :c:type:`uv_tty_mode_t` .. versionchanged:: 1.2.0: the mode is specified as a
value. :c:type:`uv_tty_mode_t` value.
Set the TTY using the specified terminal mode. Set the TTY using the specified terminal mode.