summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjluehrs2 <jluehrs2@uiuc.edu>2007-08-16 21:46:39 -0500
committerjluehrs2 <jluehrs2@uiuc.edu>2007-08-16 21:46:39 -0500
commitcb9421477043774405bb5bd18b081f0689f30557 (patch)
tree1ded9c347cbf3c8e25d90ff4e61865fef6036fa6
parent0018248887eda45afa634f7f070fc0083c180637 (diff)
downloadio-pty-easy-cb9421477043774405bb5bd18b081f0689f30557.tar.gz
io-pty-easy-cb9421477043774405bb5bd18b081f0689f30557.zip
pod also requires newlines before commands
-rw-r--r--lib/IO/Pty/Easy.pm12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/IO/Pty/Easy.pm b/lib/IO/Pty/Easy.pm
index cf86a24..f69ba29 100644
--- a/lib/IO/Pty/Easy.pm
+++ b/lib/IO/Pty/Easy.pm
@@ -5,6 +5,7 @@ use IO::Pty;
use Carp;
# Intro documentation {{{
+
=head1 NAME
IO::Pty::Easy - Easy interface to creating and using pseudo-ttys with IO::Pty
@@ -44,6 +45,7 @@ C<IO::Pty::Easy> provides an interface to L<IO::Pty> which hides most of the ugl
C<IO::Pty::Easy> uses L<IO::Pty> internally, so it inherits all of the portability restrictions from that module.
=cut
+
# }}}
=head1 CONSTRUCTOR
@@ -51,6 +53,7 @@ C<IO::Pty::Easy> uses L<IO::Pty> internally, so it inherits all of the portabili
=cut
# new() {{{
+
=head2 new()
The C<new> constructor initializes the pty and returns a new C<IO::Pty::Easy> object. The constructor recognizes these parameters:
@@ -95,6 +98,7 @@ sub new {
=cut
# spawn() {{{
+
=head2 spawn()
Fork a new subprocess, with stdin/stdout/stderr tied to the PTY.
@@ -177,6 +181,7 @@ sub spawn {
# }}}
# read() {{{
+
=head2 read()
Read data from the process running on the PTY.
@@ -206,6 +211,7 @@ sub read {
# }}}
# write() {{{
+
=head2 write()
Writes a string to the PTY.
@@ -233,6 +239,7 @@ sub write {
# }}}
# is_active() {{{
+
=head2 is_active()
Returns whether or not a subprocess is currently running on the PTY.
@@ -247,6 +254,7 @@ sub is_active {
# }}}
# kill() {{{
+
=head2 kill()
Kills the process currently running on the PTY (if any). After this call, C<read()> and C<write()> will fail, and a new process can be created on the PTY with C<spawn()>.
@@ -264,6 +272,7 @@ sub kill {
# }}}
# close() {{{
+
=head2 close()
Kills any subprocesses and closes the PTY. No other operations are valid after this call.
@@ -284,9 +293,11 @@ sub close {
# }}}
# Ending documentation {{{
+
=head1 SEE ALSO
L<IO::Pty>
+
L<Expect>
=head1 AUTHOR
@@ -339,6 +350,7 @@ This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=cut
+
# }}}
1;