.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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::SSH2::Channel 3pm"
.TH Net::SSH2::Channel 3pm "2011-05-07" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::SSH2::Channel \- SSH 2 channel object
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A channel object is created by the Net::SSH2 \f(CW\*(C`channel\*(C'\fR method.  As well
as being an object, it is also a tied filehandle.  The Net::SSH2 \f(CW\*(C`poll\*(C'\fR
method can be used to check for read/write availability and other conditions.
.SS "setenv ( key, value ... )"
.IX Subsection "setenv ( key, value ... )"
Sets remote environment variables.  Note that most implementations do not allow
environment variables to be freely set.  Pass in a list of keys and values
with the values to set.  Returns the number of successful sets.
.SS "blocking ( flag )"
.IX Subsection "blocking ( flag )"
Enable or disable blocking.  Note that this is currently implemented in libssh2
by setting a per-session flag; it's equivalent to Net::SSH2::blocking.
.SS "eof"
.IX Subsection "eof"
Returns true if the remote server sent an \s-1EOF\s0.
.SS "send_eof"
.IX Subsection "send_eof"
Send an \s-1EOF\s0 to the remote.  After an \s-1EOF\s0 has been sent, no more data may be
sent; the connection should be closed.
.SS "close"
.IX Subsection "close"
Close the channel (happens automatically on object destruction).
.SS "wait_closed"
.IX Subsection "wait_closed"
Wait for a remote close event.  Must have already seen remote \s-1EOF\s0.
.SS "exit_status"
.IX Subsection "exit_status"
Returns the channel's program exit status.
.SS "pty ( terminal [, modes [, width [, height ]]] )"
.IX Subsection "pty ( terminal [, modes [, width [, height ]]] )"
Request a terminal on a channel.  If provided, \f(CW\*(C`width\*(C'\fR and \f(CW\*(C`height\*(C'\fR are the
width and height in characters (defaults to 80x24); if negative their absolute
values specify width and height in pixels.
.SS "pty_size ( width, height )"
.IX Subsection "pty_size ( width, height )"
Request a terminal size change on a channel. \f(CW\*(C`width\*(C'\fR and \f(CW\*(C`height\*(C'\fR are the
width and height in characters; if negative their absolute values specify
width and height in pixels.
.SS "process ( request, message )"
.IX Subsection "process ( request, message )"
Start a process on the channel.  See also shell, exec, subsystem.
.SS "shell"
.IX Subsection "shell"
Start a shell on the remote host; calls process(\*(L"shell\*(R").
.SS "exec ( command )"
.IX Subsection "exec ( command )"
Execute the command on the remote host; calls process(\*(L"exec\*(R", command).
Note that only one of these requests can succeed per channel (cp.
\&\*(L"exec\*(R" in perlfunc); if you want to run a series of commands, consider using
shell instead.
.SS "subsystem ( name )"
.IX Subsection "subsystem ( name )"
Run subsystem on the remote host; calls process(\*(L"subsystem\*(R", command).
.SS "ext_data ( mode )"
.IX Subsection "ext_data ( mode )"
Set extended data handling mode:
.IP "normal (default)" 4
.IX Item "normal (default)"
Keep data in separate channels; stderr is read separately.
.IP "ignore" 4
.IX Item "ignore"
Ignore all extended data.
.IP "merge" 4
.IX Item "merge"
Merge into the regular channel.
.SS "read ( buffer, size [, ext ] )"
.IX Subsection "read ( buffer, size [, ext ] )"
Attempts to read size bytes into the buffer.  Returns number of bytes read,
undef on failure.  If ext is present and set, reads from the extended data
channel (stderr).
.SS "write ( buffer [, ext ] )"
.IX Subsection "write ( buffer [, ext ] )"
Attempts to write the buffer to the channel.  Returns number of bytes written,
undef on failure.  If ext is present and set, writes to the extended data
channel (stderr).
.SS "flush ( [ ext ] )"
.IX Subsection "flush ( [ ext ] )"
Flushes the channel; if ext is present and set, flushes extended data channel.
Returns number of bytes flushed, undef on error.
.SS "exit_signal"
.IX Subsection "exit_signal"
Returns the exit signal of the command executed on the channel. Requires libssh
1.2.8 or higher.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::SSH2.
.SH "AUTHOR"
.IX Header "AUTHOR"
David B. Robins, <dbrobins@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2005, 2006 by David B. Robins; all rights reserved.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.0 or,
at your option, any later version of Perl 5 you may have available.