summaryrefslogtreecommitdiff
path: root/io.c
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2012-03-06 03:31:12 +0000
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2012-03-06 03:31:12 +0000
commit9ca160c168abf64695e7ff89beb72c0ce5eed6a6 (patch)
treeeec8bbe3f2ec9c0d7f1d9a6924997fa04d246b15 /io.c
parent0c493edcce15d30f09d18fe451c458014be02996 (diff)
merge revision(s) 33172,33968:
* ext/io/console/console.c (console_set_winsize): remove unused variable. * io.c (Init_IO): Mention io/console methods. [Ruby 1.9 - Bug #5602] * ext/io/console/console.c: Mention that io/console must be required similar to lib/time.rb git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_9_3@34922 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'io.c')
-rw-r--r--io.c29
1 files changed, 29 insertions, 0 deletions
diff --git a/io.c b/io.c
index 2945764d64..0e17d44ba6 100644
--- a/io.c
+++ b/io.c
@@ -10699,6 +10699,35 @@ argf_write(VALUE argf, VALUE str)
* command line (or STDIN if no files are mentioned). ARGF provides
* the methods <code>#path</code> and <code>#filename</code> to access
* the name of the file currently being read.
+ *
+ * == io/console
+ *
+ * The io/console extension provides methods for interacting with the
+ * console. The console can be accessed from <code>IO.console</code> or
+ * the standard input/output/error IO objects.
+ *
+ * Requiring io/console adds the following methods:
+ *
+ * * IO::console
+ * * IO#raw
+ * * IO#raw!
+ * * IO#cooked
+ * * IO#cooked!
+ * * IO#getch
+ * * IO#echo=
+ * * IO#echo?
+ * * IO#noecho
+ * * IO#winsize
+ * * IO#winsize=
+ * * IO#iflush
+ * * IO#ioflush
+ * * IO#oflush
+ *
+ * Example:
+ *
+ * require 'io/console'
+ * rows, columns = $stdin.winsize
+ * puts "You screen is #{columns} wide and #{rows} tall"
*/
void