aboutsummaryrefslogtreecommitdiffstats
path: root/ext/pty/README
diff options
context:
space:
mode:
Diffstat (limited to 'ext/pty/README')
-rw-r--r--ext/pty/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/ext/pty/README b/ext/pty/README
index 42c7d4f891..d6368f3758 100644
--- a/ext/pty/README
+++ b/ext/pty/README
@@ -43,6 +43,25 @@ following module fungtions:
These functions are obsolete in this version of pty.
+ PTY.open
+
+ Allocates a pty (pseudo-terminal).
+
+ It returns an array which contains an IO object and a File object.
+ The former is the master of the pty.
+ The latter is the slave of the pty.
+
+ If a block is given, it yields the array instead of return.
+ The value of the block is returned.
+ master_io and slave_file is closed when return if they are not closed.
+
+ PTY.check(pid[, raise=false])
+
+ checks the status of the child process specified by pid, and
+ returns nil if the process is still alive and active.
+ Otherwise, returns Process::Status about the process if raise is
+ false, or PTY::ChildExited exception is raised.
+
4. License
(C) Copyright 1998 by Akinori Ito.