.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::OpenSSH::Compat::Perl 3pm"
.TH Net::OpenSSH::Compat::Perl 3pm "2016-07-02" "perl v5.22.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::OpenSSH::Compat::Perl \- Net::OpenSSH adapter for Net::SSH::Perl API compatibility
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Net::OpenSSH::Compat::Perl qw(:supplant);
\&
\&  use Net::SSH::Perl;
\&
\&  my $ssh = Net::SSH::Perl\->new(\*(Aqhost\*(Aq);
\&  $ssh\->login($user, $passwd);
\&
\&  my ($out, $err, $rc) = $ssh\->cmd($cmd);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements a subset of Net::SSH::Perl \s-1API\s0 on top of
Net::OpenSSH.
.PP
After the module is loaded as...
.PP
.Vb 1
\&  use Net::OpenSSH::Compat::Perl qw(:supplant);
.Ve
.PP
\&... it supplants the Net::SSH::Perl module as if it were installed on
the machine using Net::OpenSSH under the hood to handle \s-1SSH\s0
operations.
.SS "Setting defaults"
.IX Subsection "Setting defaults"
The hash \f(CW%Net::OpenSSH::Compat::Perl::DEFAULTS\fR can be used to set
default values for Net::OpenSSH and other modules called under the
hood and otherwise not accessible through the Net::SSH::Perl \s-1API.\s0
.PP
The entries currently supported are:
.ie n .IP "connection => [ %opts ]" 4
.el .IP "connection => [ \f(CW%opts\fR ]" 4
.IX Item "connection => [ %opts ]"
Extra options passed to \f(CW\*(C`Net::OpenSSH::new\*(C'\fR constructor.
.Sp
Example:
.Sp
.Vb 2
\&  $Net::OpenSSH::Compat::SSH::Perl::DEFAULTS{connection} =
\&    [ ssh_path => "/opt/SSH/bin/ssh" ];
.Ve
.SH "BUGS AND SUPPORT"
.IX Header "BUGS AND SUPPORT"
\&\fBThis is a work in progress.\fR
.PP
\&\f(CW\*(C`register_handler\*(C'\fR method is not supported.
.PP
Net::SSH::Perl submodules (i.e. Net::SSH::Perl::Channel) are not emulated.
.PP
Anyway, if your Net::SSH::Perl script fails, fill a bug report at the \s-1CPAN
RT\s0 bugtracker
(<https://rt.cpan.org/Ticket/Create.html?Queue=Net\-OpenSSH\-Compat>)
or just send me an e\-mail with the details.
.PP
Include at least:
.IP "1 \- The full source of the script" 4
.IX Item "1 - The full source of the script"
.PD 0
.IP "2 \- A description of what happens in your machine" 4
.IX Item "2 - A description of what happens in your machine"
.IP "3 \- What you thing it should be happening" 4
.IX Item "3 - What you thing it should be happening"
.IP "4 \- What happens when you use the real Net::SSH::Perl" 4
.IX Item "4 - What happens when you use the real Net::SSH::Perl"
.IP "5 \- The version and name of your operating system" 4
.IX Item "5 - The version and name of your operating system"
.ie n .IP "6 \- The version of the OpenSSH ssh client installed on your machine (""ssh \-V"")" 4
.el .IP "6 \- The version of the OpenSSH ssh client installed on your machine (\f(CWssh \-V\fR)" 4
.IX Item "6 - The version of the OpenSSH ssh client installed on your machine (ssh -V)"
.ie n .IP "7 \- The Perl version (""perl \-V"")" 4
.el .IP "7 \- The Perl version (\f(CWperl \-V\fR)" 4
.IX Item "7 - The Perl version (perl -V)"
.IP "8 \- The versions of the Perl packages Net::OpenSSH, IO::Pty and this Net::OpenSSH::Compat." 4
.IX Item "8 - The versions of the Perl packages Net::OpenSSH, IO::Pty and this Net::OpenSSH::Compat."
.PD
.SS "Git repository"
.IX Subsection "Git repository"
The source code repository is at
<https://github.com/salva/p5\-Net\-OpenSSH\-Compat>.
.SS "My wishlist"
.IX Subsection "My wishlist"
If you like this module and you're feeling generous, take a look at my
Amazon Wish List: <http://amzn.com/w/1WU1P6IR5QZ42>
.PP
Also consider contributing to the OpenSSH project this module builds
upon: <http://www.openssh.org/donations.html>.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2011, 2014\-2016 by Salvador Fandiño (sfandino@yahoo.com)
.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.10.0 or,
at your option, any later version of Perl 5 you may have available.