Initial commit of OpenSPARC T2 design and verification files.

[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Net::Telnet.3

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Net::Telnet 3"
.TH Net::Telnet 3 "2002-07-16" "perl v5.8.0" "User Contributed Perl Documentation"
.SH "NAME"
Net::Telnet \- interact with TELNET port or other TCP ports
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\f(CW\*(C`use Net::Telnet ();\*(C'\fR
.PP
see \s-1METHODS\s0 section below
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Net::Telnet allows you to make client connections to a \s-1TCP\s0 port and do
network I/O, especially to a port using the \s-1TELNET\s0 protocol.  Simple
I/O methods such as print, get, and getline are provided.  More
sophisticated interactive features are provided because connecting to
a \s-1TELNET\s0 port ultimately means communicating with a program designed
for human interaction.  These interactive features include the ability
to specify a time-out and to wait for patterns to appear in the input
stream, such as the prompt from a shell.
.PP
Other reasons to use this module than strictly with a \s-1TELNET\s0 port are:
.IP "\(bu" 2
You're not familiar with sockets and you want a simple way to make
client connections to \s-1TCP\s0 services.
.IP "\(bu" 2
You want to be able to specify your own time-out while connecting,
reading, or writing.
.IP "\(bu" 2
You're communicating with an interactive program at the other end of
some socket or pipe and you want to wait for certain patterns to
appear.
.PP
Here's an example that prints who's logged-on to the remote host
sparky.  In addition to a username and password, you must also know
the user's shell prompt, which for this example is \f(CW\*(C`bash$\*(C'\fR
.PP
.Vb 7
\&    use Net::Telnet ();
\&    $t = new Net::Telnet (Timeout => 10,
\&                          Prompt => '/bash\e$ $/');
\&    $t->open("sparky");
\&    $t->login($username, $passwd);
\&    @lines = $t->cmd("who");
\&    print @lines;
.Ve
.PP
More examples are in the \fB\s-1EXAMPLES\s0\fR section below.
.PP
Usage questions should be directed to the Usenet newsgroup
comp.lang.perl.modules.
.PP
Contact me, Jay Rogers <jay@rgrs.com>, if you find any bugs or have
suggestions for improvement.
.Sh "What To Know Before Using"
.IX Subsection "What To Know Before Using"
.IP "\(bu" 2
All output is flushed while all input is buffered.  Each object
contains its own input buffer.
.IP "\(bu" 2
The output record separator for \f(CW\*(C`print()\*(C'\fR and \f(CW\*(C`cmd()\*(C'\fR is set to
\&\f(CW"\en"\fR by default, so that you don't have to append all your commands
with a newline.  To avoid printing a trailing \f(CW"\en"\fR use \f(CW\*(C`put()\*(C'\fR or
set the \fIoutput_record_separator\fR to \f(CW""\fR.
.IP "\(bu" 2
The methods \f(CW\*(C`login()\*(C'\fR and \f(CW\*(C`cmd()\*(C'\fR use the \fIprompt\fR setting in the
object to determine when a login or remote command is complete.  Those
methods will fail with a time-out if you don't set the prompt
correctly.
.IP "\(bu" 2
Use a combination of \f(CW\*(C`print()\*(C'\fR and \f(CW\*(C`waitfor()\*(C'\fR as an alternative to
\&\f(CW\*(C`login()\*(C'\fR or \f(CW\*(C`cmd()\*(C'\fR when they don't do what you want.
.IP "\(bu" 2
Errors such as timing-out are handled according to the error mode
action.  The default action is to print an error message to standard
error and have the program die.  See the \f(CW\*(C`errmode()\*(C'\fR method for more
information.
.IP "\(bu" 2
When constructing the match operator argument for \f(CW\*(C`prompt()\*(C'\fR or
\&\f(CW\*(C`waitfor()\*(C'\fR, always use single quotes instead of double quotes to
avoid unexpected backslash interpretation (e.g. \f(CW'/bash\e$ $/'\fR).  If
you're constructing a \s-1DOS\s0 like file path, you'll need to use four
backslashes to represent one (e.g. \f(CW'/c:\e\e\e\eusers\e\e\e\ebill>$/i'\fR).
.Sp
Of course don't forget about regexp metacharacters like \f(CW\*(C`.\*(C'\fR, \f(CW\*(C`[\*(C'\fR, or
\&\f(CW\*(C`$\*(C'\fR.  You'll only need a single backslash to quote them.  The anchor
metacharacters \f(CW\*(C`^\*(C'\fR and \f(CW\*(C`$\*(C'\fR refer to positions in the input buffer.
To avoid matching characters read that look like a prompt, it's a good
idea to end your prompt pattern with the \f(CW\*(C`$\*(C'\fR anchor.  That way the
prompt will only match if it's the last thing read.
.IP "\(bu" 2
In the input stream, each sequence of \fIcarriage return\fR and \fIline
feed\fR (i.e. \f(CW"\e015\e012"\fR or \s-1CR\s0 \s-1LF\s0) is converted to \f(CW"\en"\fR.  In the
output stream, each occurrence of \f(CW"\en"\fR is converted to a sequence
of \s-1CR\s0 \s-1LF\s0.  See \f(CW\*(C`binmode()\*(C'\fR to change the behavior.  \s-1TCP\s0 protocols
typically use the \s-1ASCII\s0 sequence, carriage return and line feed to
designate a newline.
.IP "\(bu" 2
Timing-out while making a connection is disabled for machines that
don't support the \f(CW\*(C`alarm()\*(C'\fR function.  Most notably these include
MS-Windows machines.
.IP "\(bu" 2
You'll need to be running at least Perl version 5.002 to use this
module.  This module does not require any libraries that don't already
come with a standard Perl distribution.
.Sp
If you have the \s-1IO::\s0 libraries installed (they come standard with
perl5.004 and later) then IO::Socket::INET is used as a base class,
otherwise FileHandle is used.
.IP "\(bu" 2
Contact me, Jay Rogers <jay@rgrs.com>, if you find any bugs or have
suggestions for improvement.
.Sh "Debugging"
.IX Subsection "Debugging"
The typical usage bug causes a time-out error because you've made
incorrect assumptions about what the remote side actually sends.  The
easiest way to reconcile what the remote side sends with your
expectations is to use \f(CW\*(C`input_log()\*(C'\fR or \f(CW\*(C`dump_log()\*(C'\fR.
.PP
\&\f(CW\*(C`dump_log()\*(C'\fR allows you to see the data being sent from the remote
side before any translation is done, while \f(CW\*(C`input_log()\*(C'\fR shows you
the results after translation.  The translation includes converting
end of line characters, removing and responding to \s-1TELNET\s0 protocol
commands in the data stream.
.Sh "Style of Named Parameters"
.IX Subsection "Style of Named Parameters"
Two different styles of named parameters are supported.  This document
only shows the \s-1IO::\s0 style:
.PP
.Vb 1
\&    Net::Telnet->new(Timeout => 20);
.Ve
.PP
however the dash-option style is also allowed:
.PP
.Vb 1
\&    Net::Telnet->new(-timeout => 20);
.Ve
.Sh "Connecting to a Remote MS-Windows Machine"
.IX Subsection "Connecting to a Remote MS-Windows Machine"
By default MS-Windows doesn't come with a \s-1TELNET\s0 server.  However
third party \s-1TELNET\s0 servers are available.  Unfortunately many of these
servers falsely claim to be a \s-1TELNET\s0 server.  This is especially true
of the so-called \*(L"Microsoft Telnet Server\*(R" that comes installed with
some newer versions MS\-Windows.
.PP
When a \s-1TELNET\s0 server first accepts a connection, it must use the \s-1ASCII\s0
control characters carriage-return and line-feed to start a new line
(see \s-1RFC854\s0).  A server like the \*(L"Microsoft Telnet Server\*(R" that
doesn't do this, isn't a \s-1TELNET\s0 server.  These servers send \s-1ANSI\s0
terminal escape sequences to position to a column on a subsequent line
and to even position while writing characters that are adjacent to
each other.  Worse, when sending output these servers resend
previously sent command output in a misguided attempt to display an
entire terminal screen.
.PP
Connecting Net::Telnet to one of these false \s-1TELNET\s0 servers makes your
job of parsing command output very difficult.  It's better to replace
a false \s-1TELNET\s0 server with a real \s-1TELNET\s0 server.  The better \s-1TELNET\s0
servers for MS-Windows allow you to avoid the \s-1ANSI\s0 escapes by turning
off something some of them call \fIconsole mode\fR.
.SH "METHODS"
.IX Header "METHODS"
In the calling sequences below, square brackets \fB[]\fR represent
optional parameters.
.IP "\fBnew\fR \- create a new Net::Telnet object" 4
.IX Item "new - create a new Net::Telnet object"
.Vb 1
\&    $obj = new Net::Telnet ([$host]);
.Ve
.Sp
.Vb 17
\&    $obj = new Net::Telnet ([Binmode    => $mode,]
\&                            [Cmd_remove_mode => $mode,]
\&                            [Dump_Log   => $filename,]
\&                            [Errmode    => $errmode,]
\&                            [Fhopen     => $filehandle,]
\&                            [Host       => $host,]
\&                            [Input_log  => $file,]
\&                            [Input_record_separator => $chars,]
\&                            [Option_log => $file,]
\&                            [Ors        => $chars,]
\&                            [Output_log => $file,]
\&                            [Output_record_separator => $chars,]
\&                            [Port       => $port,]
\&                            [Prompt     => $matchop,]
\&                            [Rs         => $chars,]
\&                            [Telnetmode => $mode,]
\&                            [Timeout    => $secs,]);
.Ve
.Sp
This is the constructor for Net::Telnet objects.  A new object is
returned on success, the error mode action is performed on failure \-
see \f(CW\*(C`errmode()\*(C'\fR.  The optional arguments are short-cuts to methods of
the same name.
.Sp
If the \fI$host\fR argument is given then the object is opened by
connecting to \s-1TCP\s0 \fI$port\fR on \fI$host\fR.  Also see \f(CW\*(C`open()\*(C'\fR.  The new
object returned is given the following defaults in the absence of
corresponding named parameters:
.RS 4
.IP "\(bu" 4
The default \fIHost\fR is \f(CW"localhost"\fR
.IP "\(bu" 4
The default \fIPort\fR is \f(CW23\fR
.IP "\(bu" 4
The default \fIPrompt\fR is \f(CW'/[\e$%#>] $/'\fR
.IP "\(bu" 4
The default \fITimeout\fR is \f(CW10\fR
.IP "\(bu" 4
The default \fIErrmode\fR is \f(CW"die"\fR
.IP "\(bu" 4
The default \fIOutput_record_separator\fR is \f(CW"\en"\fR.  Note that \fIOrs\fR
is synonymous with \fIOutput_record_separator\fR.
.IP "\(bu" 4
The default \fIInput_record_separator\fR is \f(CW"\en"\fR.  Note that \fIRs\fR is
synonymous with \fIInput_record_separator\fR.
.IP "\(bu" 4
The default \fIBinmode\fR is \f(CW0\fR, which means do newline translation.
.IP "\(bu" 4
The default \fITelnetmode\fR is \f(CW1\fR, which means respond to \s-1TELNET\s0
commands in the data stream.
.IP "\(bu" 4
The default \fICmd_remove_mode\fR is \f(CW"auto"\fR
.IP "\(bu" 4
The defaults for \fIDump_log\fR, \fIInput_log\fR, \fIOption_log\fR, and
\&\fIOutput_log\fR are \f(CW""\fR, which means that logging is turned\-off.
.RE
.RS 4
.RE
.IP "\fBbinmode\fR \- toggle newline translation" 4
.IX Item "binmode - toggle newline translation"
.Vb 1
\&    $mode = $obj->binmode;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->binmode($mode);
.Ve
.Sp
This method controls whether or not sequences of carriage returns and
line feeds (\s-1CR\s0 \s-1LF\s0 or more specifically \f(CW"\e015\e012"\fR) are translated.
By default they are translated (i.e. binmode is \f(CW0\fR).
.Sp
If no argument is given, the current mode is returned.
.Sp
If \fI$mode\fR is \f(CW1\fR then binmode is \fIon\fR and newline translation is
not done.
.Sp
If \fI$mode\fR is \f(CW0\fR then binmode is \fIoff\fR and newline translation is
done.  In the input stream, each sequence of \s-1CR\s0 \s-1LF\s0 is converted to
\&\f(CW"\en"\fR and in the output stream, each occurrence of \f(CW"\en"\fR is
converted to a sequence of \s-1CR\s0 \s-1LF\s0.
.Sp
Note that input is always buffered.  Changing binmode doesn't effect
what's already been read into the buffer.  Output is not buffered and
changing binmode will have an immediate effect.
.IP "\fBbreak\fR \- send \s-1TELNET\s0 break character" 4
.IX Item "break - send TELNET break character"
.Vb 1
\&    $ok = $obj->break;
.Ve
.Sp
This method sends the \s-1TELNET\s0 break character.  This character is
provided because it's a signal outside the \s-1ASCII\s0 character set which
is currently given local meaning within many systems.  It's intended
to indicate that the Break Key or the Attention Key was hit.
.Sp
This method returns \f(CW1\fR on success, or performs the error mode action
on failure.
.IP "\fBbuffer\fR \- scalar reference to object's input buffer" 4
.IX Item "buffer - scalar reference to object's input buffer"
.Vb 1
\&    $ref = $obj->buffer;
.Ve
.Sp
This method returns a scalar reference to the input buffer for
\&\fI$obj\fR.  Data in the input buffer is data that has been read from the
remote side but has yet to be read by the user.  Modifications to the
input buffer are returned by a subsequent read.
.IP "\fBbuffer_empty\fR \- discard all data in object's input buffer" 4
.IX Item "buffer_empty - discard all data in object's input buffer"
.Vb 1
\&    $obj->buffer_empty;
.Ve
.Sp
This method removes all data in the input buffer for \fI$obj\fR.
.IP "\fBclose\fR \- close object" 4
.IX Item "close - close object"
.Vb 1
\&    $ok = $obj->close;
.Ve
.Sp
This method closes the socket, file, or pipe associated with the
object.  It always returns a value of \f(CW1\fR.
.IP "\fBcmd\fR \- issue command and retrieve output" 4
.IX Item "cmd - issue command and retrieve output"
.Vb 11
\&    $ok = $obj->cmd($string);
\&    $ok = $obj->cmd(String   => $string,
\&                    [Output  => $ref,]
\&                    [Cmd_remove_mode => $mode,]
\&                    [Errmode => $mode,]
\&                    [Input_record_separator => $chars,]
\&                    [Ors     => $chars,]
\&                    [Output_record_separator => $chars,]
\&                    [Prompt  => $match,]
\&                    [Rs      => $chars,]
\&                    [Timeout => $secs,]);
.Ve
.Sp
.Vb 11
\&    @output = $obj->cmd($string);
\&    @output = $obj->cmd(String   => $string,
\&                        [Output  => $ref,]
\&                        [Cmd_remove_mode => $mode,]
\&                        [Errmode => $mode,]
\&                        [Input_record_separator => $chars,]
\&                        [Ors     => $chars,]
\&                        [Output_record_separator => $chars,]
\&                        [Prompt  => $match,]
\&                        [Rs      => $chars,]
\&                        [Timeout => $secs,]);
.Ve
.Sp
This method sends the command \fI$string\fR, and reads the characters
sent back by the command up until and including the matching prompt.
It's assumed that the program to which you're sending is some kind of
command prompting interpreter such as a shell.
.Sp
The command \fI$string\fR is automatically appended with the
output_record_separator, By default that's \f(CW"\en"\fR.  This is similar
to someone typing a command and hitting the return key.  Set the
output_record_separator to change this behavior.
.Sp
In a scalar context, the characters read from the remote side are
discarded and \f(CW1\fR is returned on success.  On time\-out, eof, or other
failures, the error mode action is performed.  See \f(CW\*(C`errmode()\*(C'\fR.
.Sp
In a list context, just the output generated by the command is
returned, one line per element.  In other words, all the characters in
between the echoed back command string and the prompt are returned.
If the command happens to return no output, a list containing one
element, the empty string is returned.  This is so the list will
indicate true in a boolean context.  On time\-out, eof, or other
failures, the error mode action is performed.  See \f(CW\*(C`errmode()\*(C'\fR.
.Sp
The characters that matched the prompt may be retrieved using
\&\f(CW\*(C`last_prompt()\*(C'\fR.
.Sp
Many command interpreters echo back the command sent.  In most
situations, this method removes the first line returned from the
remote side (i.e. the echoed back command).  See \f(CW\*(C`cmd_remove_mode()\*(C'\fR
for more control over this feature.
.Sp
Use \f(CW\*(C`dump_log()\*(C'\fR to debug when this method keeps timing-out and you
don't think it should.
.Sp
Consider using a combination of \f(CW\*(C`print()\*(C'\fR and \f(CW\*(C`waitfor()\*(C'\fR as an
alternative to this method when it doesn't do what you want, e.g. the
command you send prompts for input.
.Sp
The \fIOutput\fR named parameter provides an alternative method of
receiving command output.  If you pass a scalar reference, all the
output (even if it contains multiple lines) is returned in the
referenced scalar.  If you pass an array or hash reference, the lines
of output are returned in the referenced array or hash.  You can use
\&\f(CW\*(C`input_record_separator()\*(C'\fR to change the notion of what separates a
line.
.Sp
Optional named parameters are provided to override the current
settings of cmd_remove_mode, errmode, input_record_separator, ors,
output_record_separator, prompt, rs, and timeout.  Rs is synonymous
with input_record_separator and ors is synonymous with
output_record_separator.
.IP "\fBcmd_remove_mode\fR \- toggle removal of echoed commands" 4
.IX Item "cmd_remove_mode - toggle removal of echoed commands"
.Vb 1
\&    $mode = $obj->cmd_remove_mode;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->cmd_remove_mode($mode);
.Ve
.Sp
This method controls how to deal with echoed back commands in the
output returned by \fIcmd()\fR.  Typically, when you send a command to the
remote side, the first line of output returned is the command echoed
back.  Use this mode to remove the first line of output normally
returned by \fIcmd()\fR.
.Sp
If no argument is given, the current mode is returned.
.Sp
If \fI$mode\fR is \f(CW0\fR then the command output returned from \fIcmd()\fR has no
lines removed.  If \fI$mode\fR is a positive integer, then the first
\&\fI$mode\fR lines of command output are stripped.
.Sp
By default, \fI$mode\fR is set to \f(CW"auto"\fR.  Auto means that whether or
not the first line of command output is stripped, depends on whether
or not the remote side offered to echo.  By default, Net::Telnet
always accepts an offer to echo by the remote side.  You can change
the default to reject such an offer using \f(CW\*(C`option_accept()\*(C'\fR.
.Sp
A warning is printed to \s-1STDERR\s0 when attempting to set this attribute
to something that's not \f(CW"auto"\fR or a non-negative integer.
.IP "\fBdump_log\fR \- log all I/O in dump format" 4
.IX Item "dump_log - log all I/O in dump format"
.Vb 1
\&    $fh = $obj->dump_log;
.Ve
.Sp
.Vb 1
\&    $fh = $obj->dump_log($fh);
.Ve
.Sp
.Vb 1
\&    $fh = $obj->dump_log($filename);
.Ve
.Sp
This method starts or stops dump format logging of all the object's
input and output.  The dump format shows the blocks read and written
in a hexadecimal and printable character format.  This method is
useful when debugging, however you might want to first try
\&\f(CW\*(C`input_log()\*(C'\fR as it's more readable.
.Sp
If no argument is given, the current log filehandle is returned.  An
empty string indicates logging is off.
.Sp
To stop logging, use an empty string as an argument.
.Sp
If an open filehandle is given, it is used for logging and returned.
Otherwise, the argument is assumed to be the name of a file, the file
is opened and a filehandle to it is returned.  If the file can't be
opened for writing, the error mode action is performed.
.IP "\fBeof\fR \- end of file indicator" 4
.IX Item "eof - end of file indicator"
.Vb 1
\&    $eof = $obj->eof;
.Ve
.Sp
This method returns \f(CW1\fR if end of file has been read, otherwise it
returns an empty string.  Because the input is buffered this isn't the
same thing as \fI$obj\fR has closed.  In other words \fI$obj\fR can be
closed but there still can be stuff in the buffer to be read.  Under
this condition you can still read but you won't be able to write.
.IP "\fBerrmode\fR \- define action to be performed on error" 4
.IX Item "errmode - define action to be performed on error"
.Vb 1
\&    $mode = $obj->errmode;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->errmode($mode);
.Ve
.Sp
This method gets or sets the action used when errors are encountered
using the object.  The first calling sequence returns the current
error mode.  The second calling sequence sets it to \fI$mode\fR and
returns the previous mode.  Valid values for \fI$mode\fR are \f(CW"die"\fR
(the default), \f(CW"return"\fR, a \fIcoderef\fR, or an \fIarrayref\fR.
.Sp
When mode is \f(CW"die"\fR and an error is encountered using the object,
then an error message is printed to standard error and the program
dies.
.Sp
When mode is \f(CW"return"\fR then the method generating the error places
an error message in the object and returns an undefined value in a
scalar context and an empty list in list context.  The error message
may be obtained using \f(CW\*(C`errmsg()\*(C'\fR.
.Sp
When mode is a \fIcoderef\fR, then when an error is encountered
\&\fIcoderef\fR is called with the error message as its first argument.
Using this mode you may have your own subroutine handle errors.  If
\&\fIcoderef\fR itself returns then the method generating the error returns
undefined or an empty list depending on context.
.Sp
When mode is an \fIarrayref\fR, the first element of the array must be a
\&\fIcoderef\fR.  Any elements that follow are the arguments to \fIcoderef\fR.
When an error is encountered, the \fIcoderef\fR is called with its
arguments.  Using this mode you may have your own subroutine handle
errors.  If the \fIcoderef\fR itself returns then the method generating
the error returns undefined or an empty list depending on context.
.Sp
A warning is printed to \s-1STDERR\s0 when attempting to set this attribute
to something that's not \f(CW"die"\fR, \f(CW"return"\fR, a \fIcoderef\fR, or an
\&\fIarrayref\fR whose first element isn't a \fIcoderef\fR.
.IP "\fBerrmsg\fR \- most recent error message" 4
.IX Item "errmsg - most recent error message"
.Vb 1
\&    $msg = $obj->errmsg;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->errmsg(@msgs);
.Ve
.Sp
The first calling sequence returns the error message associated with
the object.  The empty string is returned if no error has been
encountered yet.  The second calling sequence sets the error message
for the object to the concatenation of \fI@msgs\fR and returns the
previous error message.  Normally, error messages are set internally
by a method when an error is encountered.
.IP "\fBerror\fR \- perform the error mode action" 4
.IX Item "error - perform the error mode action"
.Vb 1
\&    $obj->error(@msgs);
.Ve
.Sp
This method concatenates \fI@msgs\fR into a string and places it in the
object as the error message.  Also see \f(CW\*(C`errmsg()\*(C'\fR.  It then performs
the error mode action.  Also see \f(CW\*(C`errmode()\*(C'\fR.
.Sp
If the error mode doesn't cause the program to die, then an undefined
value or an empty list is returned depending on the context.
.Sp
This method is primarily used by this class or a sub-class to perform
the user requested action when an error is encountered.
.IP "\fBfhopen\fR \- use already open filehandle for I/O" 4
.IX Item "fhopen - use already open filehandle for I/O"
.Vb 1
\&    $ok = $obj->fhopen($fh);
.Ve
.Sp
This method associates the open filehandle \fI$fh\fR with \fI$obj\fR for
further I/O.  Filehandle \fI$fh\fR must already be opened.
.Sp
Suppose you want to use the features of this module to do I/O to
something other than a \s-1TCP\s0 port, for example \s-1STDIN\s0 or a filehandle
opened to read from a process.  Instead of opening the object for I/O
to a \s-1TCP\s0 port by using \f(CW\*(C`open()\*(C'\fR or \f(CW\*(C`new()\*(C'\fR, call this method
instead.
.Sp
The value \f(CW1\fR is returned success, the error mode action is performed
on failure.
.IP "\fBget\fR \- read block of data" 4
.IX Item "get - read block of data"
.Vb 4
\&    $data = $obj->get([Binmode    => $mode,]
\&                      [Errmode    => $errmode,]
\&                      [Telnetmode => $mode,]
\&                      [Timeout    => $secs,]);
.Ve
.Sp
This method reads a block of data from the object and returns it along
with any buffered data.  If no buffered data is available to return,
it will wait for data to read using the timeout specified in the
object.  You can override that timeout using \fI$secs\fR.  Also see
\&\f(CW\*(C`timeout()\*(C'\fR.  If buffered data is available to return, it also checks
for a block of data that can be immediately read.
.Sp
On eof an undefined value is returned.  On time-out or other failures,
the error mode action is performed.  To distinguish between eof or an
error occurring when the error mode is not set to \f(CW"die"\fR, use
\&\f(CW\*(C`eof()\*(C'\fR.
.Sp
Optional named parameters are provided to override the current
settings of binmode, errmode, telnetmode, and timeout.
.IP "\fBgetline\fR \- read next line" 4
.IX Item "getline - read next line"
.Vb 6
\&    $line = $obj->getline([Binmode    => $mode,]
\&                          [Errmode    => $errmode,]
\&                          [Input_record_separator => $chars,]
\&                          [Rs         => $chars,]
\&                          [Telnetmode => $mode,]
\&                          [Timeout    => $secs,]);
.Ve
.Sp
This method reads and returns the next line of data from the object.
You can use \f(CW\*(C`input_record_separator()\*(C'\fR to change the notion of what
separates a line.  The default is \f(CW"\en"\fR.  If a line isn't
immediately available, this method blocks waiting for a line or a
time\-out.
.Sp
On eof an undefined value is returned.  On time-out or other failures,
the error mode action is performed.  To distinguish between eof or an
error occurring when the error mode is not set to \f(CW"die"\fR, use
\&\f(CW\*(C`eof()\*(C'\fR.
.Sp
Optional named parameters are provided to override the current
settings of binmode, errmode, input_record_separator, rs, telnetmode,
and timeout.  Rs is synonymous with input_record_separator.
.IP "\fBgetlines\fR \- read next lines" 4
.IX Item "getlines - read next lines"
.Vb 7
\&    @lines = $obj->getlines([Binmode    => $mode,]
\&                            [Errmode    => $errmode,]
\&                            [Input_record_separator => $chars,]
\&                            [Rs         => $chars,]
\&                            [Telnetmode => $mode,]
\&                            [Timeout    => $secs,]
\&                            [All        => $boolean,]);
.Ve
.Sp
This method reads and returns all the lines of data from the object
until end of file is read.  You can use \f(CW\*(C`input_record_separator()\*(C'\fR to
change the notion of what separates a line.  The default is \f(CW"\en"\fR.
A time-out error occurs if all the lines can't be read within the
time-out interval.  See \f(CW\*(C`timeout()\*(C'\fR.
.Sp
The behavior of this method was changed in version 3.03.  Prior to
version 3.03 this method returned just the lines available from the
next read.  To get that old behavior, use the optional named parameter
\&\fIAll\fR and set \fI$boolean\fR to \f(CW""\fR or \f(CW0\fR.
.Sp
If only eof is read then an empty list is returned.  On time-out or
other failures, the error mode action is performed.  Use \f(CW\*(C`eof()\*(C'\fR to
distinguish between reading only eof or an error occurring when the
error mode is not set to \f(CW"die"\fR.
.Sp
Optional named parameters are provided to override the current
settings of binmode, errmode, input_record_separator, rs, telnetmode,
and timeout.  Rs is synonymous with input_record_separator.
.IP "\fBhost\fR \- name of remote host" 4
.IX Item "host - name of remote host"
.Vb 1
\&    $host = $obj->host;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->host($host);
.Ve
.Sp
This method designates the remote host for \f(CW\*(C`open()\*(C'\fR.  With no
argument it returns the current host name set in the object.  With an
argument it sets the current host name to \fI$host\fR and returns the
previous host name.  You may indicate the remote host using either a
hostname or an \s-1IP\s0 address.
.Sp
The default value is \f(CW"localhost"\fR.  It may also be set by \f(CW\*(C`open()\*(C'\fR
or \f(CW\*(C`new()\*(C'\fR.
.IP "\fBinput_log\fR \- log all input" 4
.IX Item "input_log - log all input"
.Vb 1
\&    $fh = $obj->input_log;
.Ve
.Sp
.Vb 1
\&    $fh = $obj->input_log($fh);
.Ve
.Sp
.Vb 1
\&    $fh = $obj->input_log($filename);
.Ve
.Sp
This method starts or stops logging of input.  This is useful when
debugging.  Also see \f(CW\*(C`dump_log()\*(C'\fR.  Because most command interpreters
echo back commands received, it's likely all your output will also be
in this log.  Note that input logging occurs after newline
translation.  See \f(CW\*(C`binmode()\*(C'\fR for details on newline translation.
.Sp
If no argument is given, the log filehandle is returned.  An empty
string indicates logging is off.
.Sp
To stop logging, use an empty string as an argument.
.Sp
If an open filehandle is given, it is used for logging and returned.
Otherwise, the argument is assumed to be the name of a file, the file
is opened for logging and a filehandle to it is returned.  If the file
can't be opened for writing, the error mode action is performed.
.IP "\fBinput_record_separator\fR \- input line delimiter" 4
.IX Item "input_record_separator - input line delimiter"
.Vb 1
\&    $chars = $obj->input_record_separator;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->input_record_separator($chars);
.Ve
.Sp
This method designates the line delimiter for input.  It's used with
\&\f(CW\*(C`getline()\*(C'\fR, \f(CW\*(C`getlines()\*(C'\fR, and \f(CW\*(C`cmd()\*(C'\fR to determine lines in the
input.
.Sp
With no argument this method returns the current input record
separator set in the object.  With an argument it sets the input
record separator to \fI$chars\fR and returns the previous value.  Note
that \fI$chars\fR must have length.
.Sp
A warning is printed to \s-1STDERR\s0 when attempting to set this attribute
to a string with no length.
.IP "\fBlast_prompt\fR \- last prompt read" 4
.IX Item "last_prompt - last prompt read"
.Vb 1
\&    $string = $obj->last_prompt;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->last_prompt($string);
.Ve
.Sp
With no argument this method returns the last prompt read by \fIcmd()\fR or
\&\fIlogin()\fR.  See \f(CW\*(C`prompt()\*(C'\fR.  With an argument it sets the last prompt
read to \fI$string\fR and returns the previous value.  Normally, only
internal methods set the last prompt.
.IP "\fBlastline\fR \- last line read" 4
.IX Item "lastline - last line read"
.Vb 1
\&    $line = $obj->lastline;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->lastline($line);
.Ve
.Sp
This method retrieves the last line read from the object.  This may be
a useful error message when the remote side abnormally closes the
connection.  Typically the remote side will print an error message
before closing.
.Sp
With no argument this method returns the last line read from the
object.  With an argument it sets the last line read to \fI$line\fR and
returns the previous value.  Normally, only internal methods set the
last line.
.IP "\fBlogin\fR \- perform standard login" 4
.IX Item "login - perform standard login"
.Vb 1
\&    $ok = $obj->login($username, $password);
.Ve
.Sp
.Vb 5
\&    $ok = $obj->login(Name     => $username,
\&                      Password => $password,
\&                      [Errmode => $mode,]
\&                      [Prompt  => $match,]
\&                      [Timeout => $secs,]);
.Ve
.Sp
This method performs a standard login by waiting for a login prompt
and responding with \fI$username\fR, then waiting for the password prompt
and responding with \fI$password\fR, and then waiting for the command
interpreter prompt.  If any of those prompts sent by the remote side
don't match what's expected, this method will time\-out, unless timeout
is turned off.
.Sp
Login prompt must match either of these case insensitive patterns:
.Sp
.Vb 2
\&    /login[: ]*$/i
\&    /username[: ]*$/i
.Ve
.Sp
Password prompt must match this case insensitive pattern:
.Sp
.Vb 1
\&    /password[: ]*$/i
.Ve
.Sp
The command interpreter prompt must match the current setting of
prompt.  See \f(CW\*(C`prompt()\*(C'\fR.
.Sp
Use \f(CW\*(C`dump_log()\*(C'\fR to debug when this method keeps timing-out and you
don't think it should.
.Sp
Consider using a combination of \f(CW\*(C`print()\*(C'\fR and \f(CW\*(C`waitfor()\*(C'\fR as an
alternative to this method when it doesn't do what you want, e.g. the
remote host doesn't prompt for a username.
.Sp
On success, \f(CW1\fR is returned.  On time out, eof, or other failures,
the error mode action is performed.  See \f(CW\*(C`errmode()\*(C'\fR.
.Sp
Optional named parameters are provided to override the current
settings of errmode, prompt, and timeout.
.IP "\fBmax_buffer_length\fR \- maximum size of input buffer" 4
.IX Item "max_buffer_length - maximum size of input buffer"
.Vb 1
\&    $len = $obj->max_buffer_length;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->max_buffer_length($len);
.Ve
.Sp
This method designates the maximum size of the input buffer.  An error
is generated when a read causes the buffer to exceed this limit.  The
default value is 1,048,576 bytes (1MB).  The input buffer can grow
much larger than the block size when you continuously read using
\&\f(CW\*(C`getline()\*(C'\fR or \f(CW\*(C`waitfor()\*(C'\fR and the data stream contains no newlines
or matching waitfor patterns.
.Sp
With no argument, this method returns the current maximum buffer
length set in the object.  With an argument it sets the maximum buffer
length to \fI$len\fR and returns the previous value.  Values of \fI$len\fR
smaller than 512 will be adjusted to 512.
.Sp
A warning is printed to \s-1STDERR\s0 when attempting to set this attribute
to something that isn't a positive integer.
.IP "\fBofs\fR \- field separator for print" 4
.IX Item "ofs - field separator for print"
.Vb 1
\&    $chars = $obj->ofs
.Ve
.Sp
.Vb 1
\&    $prev = $obj->ofs($chars);
.Ve
.Sp
This method is synonymous with \f(CW\*(C`output_field_separator()\*(C'\fR.
.IP "\fBopen\fR \- connect to port on remote host" 4
.IX Item "open - connect to port on remote host"
.Vb 1
\&    $ok = $obj->open($host);
.Ve
.Sp
.Vb 4
\&    $ok = $obj->open([Host    => $host,]
\&                     [Port    => $port,]
\&                     [Errmode => $mode,]
\&                     [Timeout => $secs,]);
.Ve
.Sp
This method opens a \s-1TCP\s0 connection to \fI$port\fR on \fI$host\fR.  If either
argument is missing then the current value of \f(CW\*(C`host()\*(C'\fR or \f(CW\*(C`port()\*(C'\fR
is used.  Optional named parameters are provided to override the
current setting of errmode and timeout.
.Sp
On success \f(CW1\fR is returned.  On time-out or other connection
failures, the error mode action is performed.  See \f(CW\*(C`errmode()\*(C'\fR.
.Sp
Time-outs don't work for this method on machines that don't implement
\&\s-1SIGALRM\s0 \- most notably MS-Windows machines.  For those machines, an
error is returned when the system reaches its own time-out while
trying to connect.
.Sp
A side effect of this method is to reset the alarm interval associated
with \s-1SIGALRM\s0.
.IP "\fBoption_accept\fR \- indicate willingness to accept a \s-1TELNET\s0 option" 4
.IX Item "option_accept - indicate willingness to accept a TELNET option"
.Vb 4
\&    $fh = $obj->option_accept([Do   => $telopt,]
\&                              [Dont => $telopt,]
\&                              [Will => $telopt,]
\&                              [Wont => $telopt,]);
.Ve
.Sp
This method is used to indicate whether to accept or reject an offer
to enable a \s-1TELNET\s0 option made by the remote side.  If you're using
\&\fIDo\fR or \fIWill\fR to indicate a willingness to enable, then a
notification callback must have already been defined by a prior call
to \f(CW\*(C`option_callback()\*(C'\fR.  See \f(CW\*(C`option_callback()\*(C'\fR for details on
receiving enable/disable notification of a \s-1TELNET\s0 option.
.Sp
You can give multiple \fIDo\fR, \fIDont\fR, \fIWill\fR, or \fIWont\fR arguments
for different \s-1TELNET\s0 options in the same call to this method.
.Sp
The following example describes the meaning of the named parameters.
A \s-1TELNET\s0 option, such as \f(CW\*(C`TELOPT_ECHO\*(C'\fR used below, is an integer
constant that you can import from Net::Telnet.  See the source in file
Telnet.pm for the complete list.
.RS 4
.IP "\(bu" 4
\&\fIDo\fR => \f(CW\*(C`TELOPT_ECHO\*(C'\fR
.RS 4
.IP "\(bu" 4
we'll accept an offer to enable the echo option on the local side
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fIDont\fR => \f(CW\*(C`TELOPT_ECHO\*(C'\fR
.RS 4
.IP "\(bu" 4
we'll reject an offer to enable the echo option on the local side
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fIWill\fR => \f(CW\*(C`TELOPT_ECHO\*(C'\fR
.RS 4
.IP "\(bu" 4
we'll accept an offer to enable the echo option on the remote side
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fIWont\fR => \f(CW\*(C`TELOPT_ECHO\*(C'\fR
.RS 4
.IP "\(bu" 4
we'll reject an offer to enable the echo option on the remote side
.RE
.RS 4
.RE
.RE
.RS 4
.RE
.IP "\(bu" 4
Use \f(CW\*(C`option_send()\*(C'\fR to send a request to the remote side to enable or
disable a particular \s-1TELNET\s0 option.
.IP "\fBoption_callback\fR \- define the option negotiation callback" 4
.IX Item "option_callback - define the option negotiation callback"
.Vb 1
\&    $coderef = $obj->option_callback;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->option_callback($coderef);
.Ve
.Sp
This method defines the callback subroutine that's called when a
\&\s-1TELNET\s0 option is enabled or disabled.  Once defined, the
\&\fIoption_callback\fR may not be undefined.  However, calling this method
with a different \fI$coderef\fR changes it.
.Sp
A warning is printed to \s-1STDERR\s0 when attempting to set this attribute
to something that isn't a coderef.
.Sp
Here are the circumstances that invoke \fI$coderef\fR:
.RS 4
.IP "\(bu" 4
An option becomes enabled because the remote side requested an enable
and \f(CW\*(C`option_accept()\*(C'\fR had been used to arrange that it be accepted.
.IP "\(bu" 4
The remote side arbitrarily decides to disable an option that is
currently enabled.  Note that Net::Telnet always accepts a request to
disable from the remote side.
.IP "\(bu" 4
\&\f(CW\*(C`option_send()\*(C'\fR was used to send a request to enable or disable an
option and the response from the remote side has just been received.
Note, that if a request to enable is rejected then \fI$coderef\fR is
still invoked even though the option didn't change.
.RE
.RS 4
.RE
.IP "\(bu" 4
Here are the arguments passed to \fI&$coderef\fR:
.Sp
.Vb 2
\&    &$coderef($obj, $option, $is_remote,
\&              $is_enabled, $was_enabled, $buf_position);
.Ve
.RS 4
.IP "\(bu" 4
1.  \fI$obj\fR is the Net::Telnet object
.IP "\(bu" 4
2.  \fI$option\fR is the \s-1TELNET\s0 option.  Net::Telnet exports constants
for the various \s-1TELNET\s0 options which just equate to an integer.
.IP "\(bu" 4
3.  \fI$is_remote\fR is a boolean indicating for which side the option
applies.
.IP "\(bu" 4
4.  \fI$is_enabled\fR is a boolean indicating the option is enabled or
disabled
.IP "\(bu" 4
5.  \fI$was_enabled\fR is a boolean indicating the option was previously
enabled or disabled
.IP "\(bu" 4
6.  \fI$buf_position\fR is an integer indicating the position in the
object's input buffer where the option takes effect.  See \f(CW\*(C`buffer()\*(C'\fR
to access the object's input buffer.
.RE
.RS 4
.RE
.IP "\fBoption_log\fR \- log all \s-1TELNET\s0 options sent or received" 4
.IX Item "option_log - log all TELNET options sent or received"
.Vb 1
\&    $fh = $obj->option_log;
.Ve
.Sp
.Vb 1
\&    $fh = $obj->option_log($fh);
.Ve
.Sp
.Vb 1
\&    $fh = $obj->option_log($filename);
.Ve
.Sp
This method starts or stops logging of all \s-1TELNET\s0 options being sent
or received.  This is useful for debugging when you send options via
\&\f(CW\*(C`option_send()\*(C'\fR or you arrange to accept option requests from the
remote side via \f(CW\*(C`option_accept()\*(C'\fR.  Also see \f(CW\*(C`dump_log()\*(C'\fR.
.Sp
If no argument is given, the log filehandle is returned.  An empty
string indicates logging is off.
.Sp
To stop logging, use an empty string as an argument.
.Sp
If an open filehandle is given, it is used for logging and returned.
Otherwise, the argument is assumed to be the name of a file, the file
is opened for logging and a filehandle to it is returned.  If the file
can't be opened for writing, the error mode action is performed.
.IP "\fBoption_send\fR \- send \s-1TELNET\s0 option negotiation request" 4
.IX Item "option_send - send TELNET option negotiation request"
.Vb 5
\&    $ok = $obj->option_send([Do    => $telopt,]
\&                            [Dont  => $telopt,]
\&                            [Will  => $telopt,]
\&                            [Wont  => $telopt,]
\&                            [Async => $boolean,]);
.Ve
.Sp
This method is not yet implemented.  Look for it in a future version.
.IP "\fBoption_state\fR \- get current state of a \s-1TELNET\s0 option" 4
.IX Item "option_state - get current state of a TELNET option"
.Vb 1
\&    $hashref = $obj->option_state($telopt);
.Ve
.Sp
This method returns a hashref containing a copy of the current state
of \s-1TELNET\s0 option \fI$telopt\fR.
.Sp
Here are the values returned in the hash:
.RS 4
.IP "\(bu" 4
\&\fI$hashref\fR\->{remote_enabled}
.RS 4
.IP "\(bu" 4
boolean that indicates if the option is enabled on the remote side.
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fI$hashref\fR\->{remote_enable_ok}
.RS 4
.IP "\(bu" 4
boolean that indicates if it's ok to accept an offer to enable this
option on the remote side.
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fI$hashref\fR\->{remote_state}
.RS 4
.IP "\(bu" 4
string used to hold the internal state of option negotiation for this
option on the remote side.
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fI$hashref\fR\->{local_enabled}
.RS 4
.IP "\(bu" 4
boolean that indicates if the option is enabled on the local side.
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fI$hashref\fR\->{local_enable_ok}
.RS 4
.IP "\(bu" 4
boolean that indicates if it's ok to accept an offer to enable this
option on the local side.
.RE
.RS 4
.RE
.IP "\(bu" 4
\&\fI$hashref\fR\->{local_state}
.RS 4
.IP "\(bu" 4
string used to hold the internal state of option negotiation for this
option on the local side.
.RE
.RS 4
.RE
.RE
.RS 4
.RE
.IP "\fBors\fR \- output line delimiter" 4
.IX Item "ors - output line delimiter"
.Vb 1
\&    $chars = $obj->ors;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->ors($chars);
.Ve
.Sp
This method is synonymous with \f(CW\*(C`output_record_separator()\*(C'\fR.
.IP "\fBoutput_field_separator\fR \- field separator for print" 4
.IX Item "output_field_separator - field separator for print"
.Vb 1
\&    $chars = $obj->output_field_separator;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->output_field_separator($chars);
.Ve
.Sp
This method designates the output field separator for \f(CW\*(C`print()\*(C'\fR.
Ordinarily the print method simply prints out the comma separated
fields you specify.  Set this to specify what's printed between
fields.
.Sp
With no argument this method returns the current output field
separator set in the object.  With an argument it sets the output
field separator to \fI$chars\fR and returns the previous value.
.Sp
By default it's set to an empty string.
.IP "\fBoutput_log\fR \- log all output" 4
.IX Item "output_log - log all output"
.Vb 1
\&    $fh = $obj->output_log;
.Ve
.Sp
.Vb 1
\&    $fh = $obj->output_log($fh);
.Ve
.Sp
.Vb 1
\&    $fh = $obj->output_log($filename);
.Ve
.Sp
This method starts or stops logging of output.  This is useful when
debugging.  Also see \f(CW\*(C`dump_log()\*(C'\fR.  Because most command interpreters
echo back commands received, it's likely all your output would also be
in an input log.  See \f(CW\*(C`input_log()\*(C'\fR.  Note that output logging occurs
before newline translation.  See \f(CW\*(C`binmode()\*(C'\fR for details on newline
translation.
.Sp
If no argument is given, the log filehandle is returned.  An empty
string indicates logging is off.
.Sp
To stop logging, use an empty string as an argument.
.Sp
If an open filehandle is given, it is used for logging and returned.
Otherwise, the argument is assumed to be the name of a file, the file
is opened for logging and a filehandle to it is returned.  If the file
can't be opened for writing, the error mode action is performed.
.IP "\fBoutput_record_separator\fR \- output line delimiter" 4
.IX Item "output_record_separator - output line delimiter"
.Vb 1
\&    $chars = $obj->output_record_separator;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->output_record_separator($chars);
.Ve
.Sp
This method designates the output line delimiter for \f(CW\*(C`print()\*(C'\fR and
\&\f(CW\*(C`cmd()\*(C'\fR.  Set this to specify what's printed at the end of \f(CW\*(C`print()\*(C'\fR
and \f(CW\*(C`cmd()\*(C'\fR.
.Sp
The output record separator is set to \f(CW"\en"\fR by default, so there's
no need to append all your commands with a newline.  To avoid printing
the output_record_separator use \f(CW\*(C`put()\*(C'\fR or set the
output_record_separator to an empty string.
.Sp
With no argument this method returns the current output record
separator set in the object.  With an argument it sets the output
record separator to \fI$chars\fR and returns the previous value.
.IP "\fBport\fR \- remote port" 4
.IX Item "port - remote port"
.Vb 1
\&    $port = $obj->port;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->port($port);
.Ve
.Sp
This method designates the remote \s-1TCP\s0 port.  With no argument this
method returns the current port number.  With an argument it sets the
current port number to \fI$port\fR and returns the previous port.  If
\&\fI$port\fR is a \s-1TCP\s0 service name, then it's first converted to a port
number using the perl function \f(CW\*(C`getservbyname()\*(C'\fR.
.Sp
The default value is \f(CW23\fR.  It may also be set by \f(CW\*(C`open()\*(C'\fR or
\&\f(CW\*(C`new()\*(C'\fR.
.Sp
A warning is printed to \s-1STDERR\s0 when attempting to set this attribute
to something that's not a positive integer or a valid \s-1TCP\s0 service
name.
.IP "\fBprint\fR \- write to object" 4
.IX Item "print - write to object"
.Vb 1
\&    $ok = $obj->print(@list);
.Ve
.Sp
This method writes \fI@list\fR followed by the \fIoutput_record_separator\fR
to the open object and returns \f(CW1\fR if all data was successfully
written.  On time-out or other failures, the error mode action is
performed.  See \f(CW\*(C`errmode()\*(C'\fR.
.Sp
By default, the \f(CW\*(C`output_record_separator()\*(C'\fR is set to \f(CW"\en"\fR so all
your commands automatically end with a newline.  In most cases your
output is being read by a command interpreter which won't accept a
command until newline is read.  This is similar to someone typing a
command and hitting the return key.  To avoid printing a trailing
\&\f(CW"\en"\fR use \f(CW\*(C`put()\*(C'\fR instead or set the output_record_separator to an
empty string.
.Sp
On failure, it's possible that some data was written.  If you choose
to try and recover from a print timing\-out, use \f(CW\*(C`print_length()\*(C'\fR to
determine how much was written before the error occurred.
.Sp
You may also use the output field separator to print a string between
the list elements.  See \f(CW\*(C`output_field_separator()\*(C'\fR.
.IP "\fBprint_length\fR \- number of bytes written by print" 4
.IX Item "print_length - number of bytes written by print"
.Vb 1
\&    $num = $obj->print_length;
.Ve
.Sp
This returns the number of bytes successfully written by the most
recent \f(CW\*(C`print()\*(C'\fR or \f(CW\*(C`put()\*(C'\fR.
.IP "\fBprompt\fR \- pattern to match a prompt" 4
.IX Item "prompt - pattern to match a prompt"
.Vb 1
\&    $matchop = $obj->prompt;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->prompt($matchop);
.Ve
.Sp
This method sets the pattern used to find a prompt in the input
stream.  It must be a string representing a valid perl pattern match
operator.  The methods \f(CW\*(C`login()\*(C'\fR and \f(CW\*(C`cmd()\*(C'\fR try to read until
matching the prompt.  They will fail with a time-out error if the
pattern you've chosen doesn't match what the remote side sends.
.Sp
With no argument this method returns the prompt set in the object.
With an argument it sets the prompt to \fI$matchop\fR and returns the
previous value.
.Sp
The default prompt is \f(CW'/[\e$%#>] $/'\fR
.Sp
Always use single quotes, instead of double quotes, to construct
\&\fI$matchop\fR (e.g. \f(CW'/bash\e$ $/'\fR).  If you're constructing a \s-1DOS\s0 like
file path, you'll need to use four backslashes to represent one
(e.g. \f(CW'/c:\e\e\e\eusers\e\e\e\ebill>$/i'\fR).
.Sp
Of course don't forget about regexp metacharacters like \f(CW\*(C`.\*(C'\fR, \f(CW\*(C`[\*(C'\fR, or
\&\f(CW\*(C`$\*(C'\fR.  You'll only need a single backslash to quote them.  The anchor
metacharacters \f(CW\*(C`^\*(C'\fR and \f(CW\*(C`$\*(C'\fR refer to positions in the input buffer.
.Sp
A warning is printed to \s-1STDERR\s0 when attempting to set this attribute
with a match operator missing its opening delimiter.
.IP "\fBput\fR \- write to object" 4
.IX Item "put - write to object"
.Vb 1
\&    $ok = $obj->put($string);
.Ve
.Sp
.Vb 5
\&    $ok = $obj->put(String      => $string,
\&                    [Binmode    => $mode,]
\&                    [Errmode    => $errmode,]
\&                    [Telnetmode => $mode,]
\&                    [Timeout    => $secs,]);
.Ve
.Sp
This method writes \fI$string\fR to the opened object and returns \f(CW1\fR if
all data was successfully written.  This method is like \f(CW\*(C`print()\*(C'\fR
except that it doesn't write the trailing output_record_separator
(\*(L"\en\*(R" by default).  On time-out or other failures, the error mode
action is performed.  See \f(CW\*(C`errmode()\*(C'\fR.
.Sp
On failure, it's possible that some data was written.  If you choose
to try and recover from a put timing\-out, use \f(CW\*(C`print_length()\*(C'\fR to
determine how much was written before the error occurred.
.Sp
Optional named parameters are provided to override the current
settings of binmode, errmode, telnetmode, and timeout.
.IP "\fBrs\fR \- input line delimiter" 4
.IX Item "rs - input line delimiter"
.Vb 1
\&    $chars = $obj->rs;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->rs($chars);
.Ve
.Sp
This method is synonymous with \f(CW\*(C`input_record_separator()\*(C'\fR.
.IP "\fBtelnetmode\fR \- turn off/on telnet command interpretation" 4
.IX Item "telnetmode - turn off/on telnet command interpretation"
.Vb 1
\&    $mode = $obj->telnetmode;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->telnetmode($mode);
.Ve
.Sp
This method controls whether or not \s-1TELNET\s0 commands in the data stream
are recognized and handled.  The \s-1TELNET\s0 protocol uses certain
character sequences sent in the data stream to control the session.
If the port you're connecting to isn't using the \s-1TELNET\s0 protocol, then
you should turn this mode off.  The default is \fIon\fR.
.Sp
If no argument is given, the current mode is returned.
.Sp
If \fI$mode\fR is \f(CW0\fR then telnet mode is off.  If \fI$mode\fR is \f(CW1\fR then
telnet mode is on.
.IP "\fBtimed_out\fR \- time-out indicator" 4
.IX Item "timed_out - time-out indicator"
.Vb 1
\&    $boolean = $obj->timed_out;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->timed_out($boolean);
.Ve
.Sp
This method indicates if a previous read, write, or open method
timed\-out.  Remember that timing-out is itself an error.  To be able
to invoke \f(CW\*(C`timed_out()\*(C'\fR after a time-out error, you'd have to change
the default error mode to something other than \f(CW"die"\fR.  See
\&\f(CW\*(C`errmode()\*(C'\fR.
.Sp
With no argument this method returns \f(CW1\fR if the previous method
timed\-out.  With an argument it sets the indicator.  Normally, only
internal methods set this indicator.
.IP "\fBtimeout\fR \- I/O time-out interval" 4
.IX Item "timeout - I/O time-out interval"
.Vb 1
\&    $secs = $obj->timeout;
.Ve
.Sp
.Vb 1
\&    $prev = $obj->timeout($secs);
.Ve
.Sp
This method sets the timeout interval that's used when performing I/O
or connecting to a port.  When a method doesn't complete within the
timeout interval then it's an error and the error mode action is
performed.
.Sp
A timeout may be expressed as a relative or absolute value.  If
\&\fI$secs\fR is greater than or equal to the time the program started, as
determined by $^T, then it's an absolute time value for when time-out
occurs.  The perl function \f(CW\*(C`time()\*(C'\fR may be used to obtain an absolute
time value.  For a relative time-out value less than $^T, time-out
happens \fI$secs\fR from when the method begins.
.Sp
If \fI$secs\fR is \f(CW0\fR then time-out occurs if the data cannot be
immediately read or written.  Use the undefined value to turn off
timing-out completely.
.Sp
With no argument this method returns the timeout set in the object.
With an argument it sets the timeout to \fI$secs\fR and returns the
previous value.  The default timeout value is \f(CW10\fR seconds.
.Sp
A warning is printed to \s-1STDERR\s0 when attempting to set this attribute
to something that's not an \f(CW\*(C`undef\*(C'\fR or a non-negative integer.
.IP "\fBwaitfor\fR \- wait for pattern in the input" 4
.IX Item "waitfor - wait for pattern in the input"
.Vb 7
\&    $ok = $obj->waitfor($matchop);
\&    $ok = $obj->waitfor([Match      => $matchop,]
\&                        [String     => $string,]
\&                        [Binmode    => $mode,]
\&                        [Errmode    => $errmode,]
\&                        [Telnetmode => $mode,]
\&                        [Timeout    => $secs,]);
.Ve
.Sp
.Vb 7
\&    ($prematch, $match) = $obj->waitfor($matchop);
\&    ($prematch, $match) = $obj->waitfor([Match      => $matchop,]
\&                                        [String     => $string,]
\&                                        [Binmode    => $mode,]
\&                                        [Errmode    => $errmode,]
\&                                        [Telnetmode => $mode,]
\&                                        [Timeout    => $secs,]);
.Ve
.Sp
This method reads until a pattern match or string is found in the
input stream.  All the characters before and including the match are
removed from the input stream.
.Sp
In a list context the characters before the match and the matched
characters are returned in \fI$prematch\fR and \fI$match\fR.  In a scalar
context, the matched characters and all characters before it are
discarded and \f(CW1\fR is returned on success.  On time\-out, eof, or other
failures, for both list and scalar context, the error mode action is
performed.  See \f(CW\*(C`errmode()\*(C'\fR.
.Sp
You can specify more than one pattern or string by simply providing
multiple \fIMatch\fR and/or \fIString\fR named parameters.  A \fI$matchop\fR
must be a string representing a valid Perl pattern match operator.
The \fI$string\fR is just a substring to find in the input stream.
.Sp
Use \f(CW\*(C`dump_log()\*(C'\fR to debug when this method keeps timing-out and you
don't think it should.
.Sp
An optional named parameter is provided to override the current
setting of timeout.
.Sp
To avoid unexpected backslash interpretation, always use single quotes
instead of double quotes to construct a match operator argument for
\&\f(CW\*(C`prompt()\*(C'\fR and \f(CW\*(C`waitfor()\*(C'\fR (e.g. \f(CW'/bash\e$ $/'\fR).  If you're
constructing a \s-1DOS\s0 like file path, you'll need to use four backslashes
to represent one (e.g. \f(CW'/c:\e\e\e\eusers\e\e\e\ebill>$/i'\fR).
.Sp
Of course don't forget about regexp metacharacters like \f(CW\*(C`.\*(C'\fR, \f(CW\*(C`[\*(C'\fR, or
\&\f(CW\*(C`$\*(C'\fR.  You'll only need a single backslash to quote them.  The anchor
metacharacters \f(CW\*(C`^\*(C'\fR and \f(CW\*(C`$\*(C'\fR refer to positions in the input buffer.
.Sp
Optional named parameters are provided to override the current
settings of binmode, errmode, telnetmode, and timeout.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\s-1RFC\s0 854" 2
.IX Item "RFC 854"
\&\s-1TELNET\s0\ Protocol\ Specification
.Sp
ftp://ftp.isi.edu/in\-notes/rfc854.txt
.IP "\s-1RFC\s0 1143" 2
.IX Item "RFC 1143"
Q\ Method\ of\ Implementing\ \s-1TELNET\s0\ Option\ Negotiation
.Sp
ftp://ftp.isi.edu/in\-notes/rfc1143.txt
.IP "\s-1TELNET\s0 Option Assignments" 2
.IX Item "TELNET Option Assignments"
http://www.iana.org/assignments/telnet\-options
.SH "EXAMPLES"
.IX Header "EXAMPLES"
This example gets the current weather forecast for Brainerd, Minnesota.
.PP
.Vb 1
\&    my ($forecast, $t);
.Ve
.PP
.Vb 3
\&    use Net::Telnet ();
\&    $t = new Net::Telnet;
\&    $t->open("rainmaker.wunderground.com");
.Ve
.PP
.Vb 3
\&    ## Wait for first prompt and "hit return".
\&    $t->waitfor('/continue:.*$/');
\&    $t->print("");
.Ve
.PP
.Vb 3
\&    ## Wait for second prompt and respond with city code.
\&    $t->waitfor('/city code.*$/');
\&    $t->print("BRD");
.Ve
.PP
.Vb 3
\&    ## Read and print the first page of forecast.
\&    ($forecast) = $t->waitfor('/[ \et]+press return to continue/i');
\&    print $forecast;
.Ve
.PP
.Vb 1
\&    exit;
.Ve
.PP
This example checks a \s-1POP\s0 server to see if you have mail.
.PP
.Vb 1
\&    my ($hostname, $line, $passwd, $pop, $username);
.Ve
.PP
.Vb 3
\&    $hostname = "your_destination_host_here";
\&    $username = "your_username_here";
\&    $passwd = "your_password_here";
.Ve
.PP
.Vb 4
\&    use Net::Telnet ();
\&    $pop = new Net::Telnet (Telnetmode => 0);
\&    $pop->open(Host => $hostname,
\&               Port => 110);
.Ve
.PP
.Vb 3
\&    ## Read connection message.
\&    $line = $pop->getline;
\&    die $line unless $line =~ /^\e+OK/;
.Ve
.PP
.Vb 4
\&    ## Send user name.
\&    $pop->print("user $username");
\&    $line = $pop->getline;
\&    die $line unless $line =~ /^\e+OK/;
.Ve
.PP
.Vb 4
\&    ## Send password.
\&    $pop->print("pass $passwd");
\&    $line = $pop->getline;
\&    die $line unless $line =~ /^\e+OK/;
.Ve
.PP
.Vb 4
\&    ## Request status of messages.
\&    $pop->print("list");
\&    $line = $pop->getline;
\&    print $line;
.Ve
.PP
.Vb 1
\&    exit;
.Ve
.PP
Here's an example that uses the ssh program to connect to a remote
host.  Because the ssh program reads and writes to its controlling
terminal, the IO::Pty module is used to create a new pseudo terminal
for use by ssh.  A new Net::Telnet object is then created to read and
write to that pseudo terminal.  To use the code below, substitute
\&\*(L"changeme\*(R" with the actual host, user, password, and command prompt.
.PP
.Vb 7
\&    ## Main program.
\&    {
\&        my ($pty, $ssh, @lines);
\&        my $host = "changeme";
\&        my $user = "changeme";
\&        my $password = "changeme";
\&        my $prompt = '/changeme:~> $/';
.Ve
.PP
.Vb 2
\&        ## Start ssh program.
\&        $pty = &spawn("ssh", "-l", $user, $host);  # spawn() defined below
.Ve
.PP
.Vb 7
\&        ## Create a Net::Telnet object to perform I/O on ssh's tty.
\&        use Net::Telnet;
\&        $ssh = new Net::Telnet (-fhopen => $pty,
\&                                -prompt => $prompt,
\&                                -telnetmode => 0,
\&                                -cmd_remove_mode => 1,
\&                                -output_record_separator => "\er");
.Ve
.PP
.Vb 8
\&        ## Login to remote host.
\&        $ssh->waitfor(-match => '/password: ?$/i',
\&                      -errmode => "return")
\&            or die "problem connecting to host: ", $ssh->lastline;
\&        $ssh->print($password);
\&        $ssh->waitfor(-match => $ssh->prompt,
\&                      -errmode => "return")
\&            or die "login failed: ", $ssh->lastline;
.Ve
.PP
.Vb 3
\&        ## Send command, get and print its output.
\&        @lines = $ssh->cmd("who");
\&        print @lines;
.Ve
.PP
.Vb 2
\&        exit;
\&    } # end main program
.Ve
.PP
.Vb 3
\&    sub spawn {
\&        my(@cmd) = @_;
\&        my($pid, $pty, $tty, $tty_fd);
.Ve
.PP
.Vb 4
\&        ## Create a new pseudo terminal.
\&        use IO::Pty ();
\&        $pty = new IO::Pty
\&            or die $!;
.Ve
.PP
.Vb 3
\&        ## Execute the program in another process.
\&        unless ($pid = fork) {  # child process
\&            die "problem spawning program: $!\en" unless defined $pid;
.Ve
.PP
.Vb 4
\&            ## Disassociate process from existing controlling terminal.
\&            use POSIX ();
\&            POSIX::setsid
\&                or die "setsid failed: $!";
.Ve
.PP
.Vb 4
\&            ## Associate process with a new controlling terminal.
\&            $tty = $pty->slave;
\&            $tty_fd = $tty->fileno;
\&            close $pty;
.Ve
.PP
.Vb 5
\&            ## Make stdio use the new controlling terminal.
\&            open STDIN, "<&$tty_fd" or die $!;
\&            open STDOUT, ">&$tty_fd" or die $!;
\&            open STDERR, ">&STDOUT" or die $!;
\&            close $tty;
.Ve
.PP
.Vb 4
\&            ## Execute requested program.
\&            exec @cmd
\&                or die "problem executing $cmd[0]\en";
\&        } # end child process
.Ve
.PP
.Vb 2
\&        $pty;
\&    } # end sub spawn
.Ve
.PP
Here's an example that changes a user's login password.  Because the
passwd program always prompts for passwords on its controlling
terminal, the IO::Pty module is used to create a new pseudo terminal
for use by passwd.  A new Net::Telnet object is then created to read
and write to that pseudo terminal.  To use the code below, substitute
\&\*(L"changeme\*(R" with the actual old and new passwords.
.PP
.Vb 3
\&    my ($pty, $passwd);
\&    my $oldpw = "changeme";
\&    my $newpw = "changeme";
.Ve
.PP
.Vb 2
\&    ## Start passwd program.
\&    $pty = &spawn("passwd");  # spawn() defined above
.Ve
.PP
.Vb 8
\&    ## Create a Net::Telnet object to perform I/O on passwd's tty.
\&    use Net::Telnet;
\&    $passwd = new Net::Telnet (-fhopen => $pty,
\&                               -timeout => 2,
\&                               -output_record_separator => "\er",
\&                               -telnetmode => 0,
\&                               -cmd_remove_mode => 1);
\&    $passwd->errmode("return");
.Ve
.PP
.Vb 4
\&    ## Send existing password.
\&    $passwd->waitfor('/password: ?$/i')
\&        or die "no old password prompt: ", $passwd->lastline;
\&    $passwd->print($oldpw);
.Ve
.PP
.Vb 4
\&    ## Send new password.
\&    $passwd->waitfor('/new password: ?$/i')
\&        or die "bad old password: ", $passwd->lastline;
\&    $passwd->print($newpw);
.Ve
.PP
.Vb 4
\&    ## Send new password verification.
\&    $passwd->waitfor('/new password: ?$/i')
\&        or die "bad new password: ", $passwd->lastline;
\&    $passwd->print($newpw);
.Ve
.PP
.Vb 4
\&    ## Display success or failure.
\&    $passwd->waitfor('/changed/')
\&        or die "bad new password: ", $passwd->lastline;
\&    print $passwd->lastline;
.Ve
.PP
.Vb 2
\&    $passwd->close;
\&    exit;
.Ve
.PP
Here's an example you can use to down load a file of any type.  The
file is read from the remote host's standard output using cat.  To
prevent any output processing, the remote host's standard output is
put in raw mode using the Bourne shell.  The Bourne shell is used
because some shells, notably tcsh, prevent changing tty modes.  Upon
completion, \s-1FTP\s0 style statistics are printed to stderr.
.PP
.Vb 3
\&    my ($block, $filename, $host, $hostname, $k_per_sec, $line,
\&        $num_read, $passwd, $prevblock, $prompt, $size, $size_bsd,
\&        $size_sysv, $start_time, $total_time, $username);
.Ve
.PP
.Vb 4
\&    $hostname = "your_destination_host_here";
\&    $username = "your_username_here";
\&    $passwd = "your_password_here";
\&    $filename = "your_download_file_here";
.Ve
.PP
.Vb 6
\&    ## Connect and login.
\&    use Net::Telnet ();
\&    $host = new Net::Telnet (Timeout => 30,
\&                             Prompt => '/[%#>] $/');
\&    $host->open($hostname);
\&    $host->login($username, $passwd);
.Ve
.PP
.Vb 4
\&    ## Make sure prompt won't match anything in send data.
\&    $prompt = "_funkyPrompt_";
\&    $host->prompt("/$prompt\e$/");
\&    $host->cmd("set prompt = '$prompt'");
.Ve
.PP
.Vb 12
\&    ## Get size of file.
\&    ($line) = $host->cmd("/bin/ls -l $filename");
\&    ($size_bsd, $size_sysv) = (split ' ', $line)[3,4];
\&    if ($size_sysv =~ /^\ed+$/) {
\&        $size = $size_sysv;
\&    }
\&    elsif ($size_bsd =~ /^\ed+$/) {
\&        $size = $size_bsd;
\&    }
\&    else {
\&        die "$filename: no such file on $hostname";
\&    }
.Ve
.PP
.Vb 5
\&    ## Start sending the file.
\&    binmode STDOUT;
\&    $host->binmode(1);
\&    $host->print("/bin/sh -c 'stty raw; cat $filename'");
\&    $host->getline;    # discard echoed back line
.Ve
.PP
.Vb 13
\&    ## Read file a block at a time.
\&    $num_read = 0;
\&    $prevblock = "";
\&    $start_time = time;
\&    while (($block = $host->get) and ($block !~ /$prompt$/o)) {
\&        if (length $block >= length $prompt) {
\&            print $prevblock;
\&            $num_read += length $prevblock;
\&            $prevblock = $block;
\&        }
\&        else {
\&            $prevblock .= $block;
\&        }
.Ve
.PP
.Vb 2
\&    }
\&    $host->close;
.Ve
.PP
.Vb 7
\&    ## Print last block without trailing prompt.
\&    $prevblock .= $block;
\&    $prevblock =~ s/$prompt$//;
\&    print $prevblock;
\&    $num_read += length $prevblock;
\&    die "error: expected size $size, received size $num_read\en"
\&        unless $num_read == $size;
.Ve
.PP
.Vb 6
\&    ## Print totals.
\&    $total_time = (time - $start_time) || 1;
\&    $k_per_sec = ($size / 1024) / $total_time;
\&    $k_per_sec = sprintf "%3.1f", $k_per_sec;
\&    warn("$num_read bytes received in $total_time seconds ",
\&         "($k_per_sec Kbytes/s)\en");
.Ve
.PP
.Vb 1
\&    exit;
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Jay Rogers <jay@rgrs.com>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 1997, 2000, 2002 by Jay Rogers.  All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.