.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.37
.\"
.\" 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::SSH::Perl::Constants 3"
.TH Net::SSH::Perl::Constants 3 "2008-10-02" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Net::SSH::Perl::Constants \- Exportable constants
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Net::SSH::Perl::Constants qw( constants );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fINet::SSH::Perl::Constants\fR provides a list of common and
useful constants for use in communicating with an sshd
server, etc.
.PP
None of the constants are exported by default; you have to
explicitly ask for them. Some of the constants are grouped
into bundles that you can grab all at once, or you can just
take the individual constants, one by one.
.PP
If you wish to import a group, your \fIuse\fR statement should
look something like this:
.PP
.Vb 1
\&    use Net::SSH::Perl::Constants qw( :group );
.Ve
.PP
Here are the groups:
.IP "* msg" 4
.IX Item "msg"
All of the \s-1MSG\s0 constants. In the \s-1SSH\s0 packet layer protocol,
each packet is identified by its type; for example, you have
a packet type for starting \s-1RSA\s0 authentication, a different
type for sending a command, etc. The \s-1MSG\s0 constants are used
when creating a new packet, then:
.Sp
.Vb 1
\&    my $packet = $ssh->packet_start( I<msg_constant> );
.Ve
.Sp
See the \fINet::SSH::Perl::Packet\fR and \fINet::SSH::Perl\fR docs
for details.
.Sp
\&\fINet::SSH::Perl\fR doesn't support all of the features of
the ssh client, so it doesn't need all of its \s-1MSG\s0
constants. For a full list of such constants, and an
explanation of each, see the \s-1SSH\s0 \s-1RFC\s0.
.Sp
Here's the list of \s-1MSG\s0 constants supported by \fINet::SSH::Perl\fR:
\&\s-1SSH_MSG_NONE\s0, \s-1SSH_MSG_DISCONNECT\s0, \s-1SSH_SMSG_PUBLIC_KEY\s0,
\&\s-1SSH_CMSG_SESSION_KEY\s0, \s-1SSH_CMSG_USER\s0, \s-1SSH_CMSG_AUTH_RHOSTS\s0,
\&\s-1SSH_CMSG_AUTH_RSA\s0, \s-1SSH_SMSG_AUTH_RSA_CHALLENGE\s0,
\&\s-1SSH_CMSG_AUTH_RSA_RESPONSE\s0, \s-1SSH_CMSG_AUTH_PASSWORD\s0,
\&\s-1SSH_CMSG_EXEC_SHELL\s0, \s-1SSH_CMSG_EXEC_CMD\s0, \s-1SSH_SMSG_SUCCESS\s0,
\&\s-1SSH_SMSG_FAILURE\s0, \s-1SSH_CMSG_STDIN_DATA\s0, \s-1SSH_SMSG_STDOUT_DATA\s0,
\&\s-1SSH_SMSG_STDERR_DATA\s0, \s-1SSH_CMSG_EOF\s0, \s-1SSH_SMSG_EXITSTATUS\s0,
\&\s-1SSH_MSG_IGNORE\s0, \s-1SSH_CMSG_EXIT_CONFIRMATION\s0,
\&\s-1SSH_CMSG_AUTH_RHOSTS_RSA\s0, \s-1SSH_MSG_DEBUG\s0,
\&\s-1SSH_CMSG_REQUEST_COMPRESSION\s0.
.IP "* hosts" 4
.IX Item "hosts"
The \s-1HOST\s0 constants: \s-1HOST_OK\s0, \s-1HOST_NEW\s0, and \s-1HOST_CHANGED\s0.
These are returned from the \f(CW\*(C`_check_host_in_hostfile\*(C'\fR
routine in \fINet::SSH::Perl::Util\fR. See those docs for
that routine for an explanation of the meaning of these
constants.
.IP "* agent" 4
.IX Item "agent"
The \s-1AGENT\s0 constants, used when talking to an authentication
agent: \s-1SSH_AGENTC_REQUEST_RSA_IDENTITIES\s0,
\&\s-1SSH_AGENT_RSA_IDENTITIES_ANSWER\s0, \s-1SSH_AGENTC_RSA_CHALLENGE\s0,
\&\s-1SSH_AGENT_RSA_RESPONSE\s0, \s-1SSH_AGENT_FAILURE\s0, \s-1SSH_AGENT_SUCCESS\s0,
\&\s-1SSH2_AGENTC_REQUEST_IDENTITIES\s0, \s-1SSH2_AGENT_IDENTITIES_ANSWER\s0,
\&\s-1SSH2_AGENTC_SIGN_REQUEST\s0, \s-1SSH2_AGENT_SIGN_RESPONSE\s0.
.PP
Other exportable constants, not belonging to a group, are:
.IP "* \s-1PROTOCOL_MAJOR\s0" 4
.IX Item "PROTOCOL_MAJOR"
.PD 0
.IP "* \s-1PROTOCOL_MINOR\s0" 4
.IX Item "PROTOCOL_MINOR"
.PD
These two constants describe the version of the protocol
supported by this \s-1SSH\s0 client (ie., \fINet::SSH::Perl\fR).
They're used when identifying the client to the server
and vice versa.
.IP "* \s-1PRIVATE_KEY_ID_STRING\s0" 4
.IX Item "PRIVATE_KEY_ID_STRING"
A special \s-1ID\s0 string written to private key files; if
the \s-1ID\s0 string in the file doesn't match this, we stop
reading the private key file.
.IP "* \s-1MAX_PACKET_SIZE\s0" 4
.IX Item "MAX_PACKET_SIZE"
The maximum size of a packet in the packet layer.
.SH "AUTHOR & COPYRIGHTS"
.IX Header "AUTHOR & COPYRIGHTS"
Please see the Net::SSH::Perl manpage for author, copyright,
and license information.