|handle_pty_size||A boolean option which determines whether or not changes in the size of the users terminal should be propageted to the pty object. Defaults to true.|
|def_max_read_chars||The maximum number of characters returned by a read() call. This can be overridden in the read() argument list. Defaults to 8192.|
|raw||A boolean option which determines whether or not to call set_raw() in IO::Pty after spawn(). Defaults to true.|
Fork a new subprocess, with stdin/stdout/stderr tied to the pty.
The argument list is passed directly to exec().
read() takes two optional arguments: the first is the number of seconds (possibly fractional) to block for data (defaults to blocking forever, 0 means completely non-blocking), and the second is the maximum number of bytes to read (defaults to the value of def_max_read_chars, usually 8192). The requirement for a maximum returned string length is a limitation imposed by the use of sysread(), which we use internally.
Returns undef on timeout, the empty string on EOF, or a string of at least one character on success (this is consistent with sysread() and Term::ReadKey).
write($buf, CW$timeout)Writes a string to the pty.
The first argument is the string to write, which is followed by one optional argument, the number of seconds (possibly fractional) to block for, taking the same values as read().
Returns whether or not a subprocess is currently running on the pty.
kill($sig, CW$non_blocking)Sends a signal to the process currently running on the pty (if any). Optionally blocks until the process dies.
kill() takes two optional arguments. The first is the signal to send, in any format that the perl kill() command recognizes (defaulting to TERM). The second is a boolean argument, where false means to block until the process dies, and true means to just send the signal and return.
Returns 1 if a process was actually signaled, and 0 otherwise.
Kills any subprocesses and closes the pty. No other operations are valid after this call.
Read/write accessor for the handle_pty_size option documented in the constructor options.
Read/write accessor for the def_max_read_chars option documented in the constructor options.
Returns the pid of the process currently running in the pty, or undef if no process is running.
No known bugs.
You can find this documentation for this module with the perldoc command.
You can also look for information at:
o AnnoCPAN: Annotated CPAN documentation o CPAN Ratings o RT: CPANs request tracker
o Search CPAN
Jesse Luehrs <doy at tozt dot net>
This software is copyright (c) 2012 by Jesse Luehrs.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
|perl v5.20.3||IO::PTY::EASY (3)||2012-03-05|