.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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 >0, 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "POE::Component::IRC::Plugin::ISupport 3pm"
.TH POE::Component::IRC::Plugin::ISupport 3pm "2018-01-01" "perl v5.26.1" "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"
POE::Component::IRC::Plugin::ISupport \- A PoCo\-IRC plugin that handles server
capabilities
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This handles the \f(CW\*(C`irc_005\*(C'\fR messages that come from the server.  They
define the capabilities support by the server.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
Takes no arguments.
.PP
Returns a plugin object suitable for feeding to
POE::Component::IRC's \f(CW\*(C`plugin_add\*(C'\fR method.
.ie n .SS """isupport"""
.el .SS "\f(CWisupport\fP"
.IX Subsection "isupport"
Takes one argument. the server capability to query. Returns a false value on
failure or a value representing the applicable capability. A full list of
capabilities is available at <http://www.irc.org/tech_docs/005.html>.
.ie n .SS """isupport_dump_keys"""
.el .SS "\f(CWisupport_dump_keys\fP"
.IX Subsection "isupport_dump_keys"
Takes no arguments, returns a list of the available server capabilities,
which can be used with \f(CW\*(C`isupport\*(C'\fR.
.SH "INPUT"
.IX Header "INPUT"
This module handles the following PoCo-IRC signals:
.ie n .SS """irc_005"" (\s-1RPL_ISUPPORT\s0 or \s-1RPL_PROTOCTL\s0)"
.el .SS "\f(CWirc_005\fP (\s-1RPL_ISUPPORT\s0 or \s-1RPL_PROTOCTL\s0)"
.IX Subsection "irc_005 (RPL_ISUPPORT or RPL_PROTOCTL)"
Denotes the capabilities of the server.
.ie n .SS """all"""
.el .SS "\f(CWall\fP"
.IX Subsection "all"
Once the next signal is received that is \fIgreater\fR than \f(CW\*(C`irc_005\*(C'\fR,
it emits an \f(CW\*(C`irc_isupport\*(C'\fR signal.
.SH "OUTPUT EVENTS"
.IX Header "OUTPUT EVENTS"
.ie n .SS """irc_isupport"""
.el .SS "\f(CWirc_isupport\fP"
.IX Subsection "irc_isupport"
Emitted by: the first signal received after \f(CW\*(C`irc_005\*(C'\fR
.PP
\&\f(CW\*(C`ARG0\*(C'\fR will be the plugin object itself for ease of use.
.PP
This is emitted when the support report has finished.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jeff \f(CW\*(C`japhy\*(C'\fR Pinyan, \fIjaphy@perlmonk.org\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
POE::Component::IRC
.PP
POE::Component::IRC::Plugin