diff options
Diffstat (limited to 'ext/io')
| -rw-r--r-- | ext/io/console/console.c | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/ext/io/console/console.c b/ext/io/console/console.c index e09213d383..dc989ccbc0 100644 --- a/ext/io/console/console.c +++ b/ext/io/console/console.c @@ -307,6 +307,15 @@ ttymode(VALUE io, VALUE (*func)(VALUE), void (*setter)(conmode *, void *), void * * will read and return a line without echo back and line editing. * + * The parameter +min+ specifies the minimum number of bytes that + * should be received when the read operation is performed. (default: + * 1) + * + * The paramter +time+ specifies the timeout in _seconds_, with a + * precision of 1/10 of a second. (default: 0) + * + * Refer to the manual page of termios for further details. + * * You must require 'io/console' to use this method. */ static VALUE @@ -324,6 +333,8 @@ console_raw(int argc, VALUE *argv, VALUE io) * * If the terminal mode needs to be back, use io.raw { ... }. * + * See IO#raw for details on the parameters. + * * You must require 'io/console' to use this method. */ static VALUE @@ -397,6 +408,8 @@ getc_call(VALUE io) * * Reads and returns a character in raw mode. * + * See IO#raw for details on the parameters. + * * You must require 'io/console' to use this method. */ static VALUE |