.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.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 "POE::Component::IRC::Plugin::CTCP 3pm"
.TH POE::Component::IRC::Plugin::CTCP 3pm "2021-09-30" "perl v5.32.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::CTCP \- A PoCo\-IRC plugin that auto\-responds to CTCP requests
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use strict;
\& use warnings;
\& use POE qw(Component::IRC Component::IRC::Plugin::CTCP);
\&
\& my $nickname = \*(AqFlibble\*(Aq . $$;
\& my $ircname = \*(AqFlibble the Sailor Bot\*(Aq;
\& my $ircserver = \*(Aqirc.blahblahblah.irc\*(Aq;
\& my $port = 6667;
\&
\& my $irc = POE::Component::IRC\->spawn(
\&     nick => $nickname,
\&     server => $ircserver,
\&     port => $port,
\&     ircname => $ircname,
\& ) or die "Oh noooo! $!";
\&
\& POE::Session\->create(
\&     package_states => [
\&         main => [ qw(_start) ],
\&     ],
\& );
\&
\& $poe_kernel\->run();
\&
\& sub _start {
\&     # Create and load our CTCP plugin
\&     $irc\->plugin_add( \*(AqCTCP\*(Aq => POE::Component::IRC::Plugin::CTCP\->new(
\&         version => $ircname,
\&         userinfo => $ircname,
\&     ));
\&
\&     $irc\->yield( register => \*(Aqall\*(Aq );
\&     $irc\->yield( connect => { } );
\&     return:
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
POE::Component::IRC::Plugin::CTCP is a POE::Component::IRC
plugin. It watches for \f(CW\*(C`irc_ctcp_version\*(C'\fR, \f(CW\*(C`irc_ctcp_userinfo\*(C'\fR,
\&\f(CW\*(C`irc_ctcp_ping\*(C'\fR, \f(CW\*(C`irc_ctcp_time\*(C'\fR and \f(CW\*(C`irc_ctcp_source\*(C'\fR events and
autoresponds on your behalf.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
Takes a number of optional arguments:
.PP
\&\fB'version'\fR, a string to send in response to \f(CW\*(C`irc_ctcp_version\*(C'\fR. Default is
PoCo-IRC and version;
.PP
\&\fB'clientinfo'\fR, a string to send in response to \f(CW\*(C`irc_ctcp_clientinfo\*(C'\fR.
Default is <http://search.cpan.org/perldoc?POE::Component::IRC::Plugin::CTCP>.
.PP
\&\fB'userinfo'\fR, a string to send in response to \f(CW\*(C`irc_ctcp_userinfo\*(C'\fR. Default
is 'm33p';
.PP
\&\fB'source'\fR, a string to send in response to \f(CW\*(C`irc_ctcp_source\*(C'\fR. Default is
<http://search.cpan.org/dist/POE\-Component\-IRC>.
.PP
\&\fB'eat'\fR, by default the plugin uses \s-1PCI_EAT_CLIENT,\s0 set this to 0 to disable
this behaviour;
.PP
Returns a plugin object suitable for feeding to
POE::Component::IRC's \f(CW\*(C`plugin_add\*(C'\fR method.
.ie n .SS """eat"""
.el .SS "\f(CWeat\fP"
.IX Subsection "eat"
With no arguments, returns true or false on whether the plugin is \*(L"eating\*(R" \s-1CTCP\s0
events that it has dealt with. An argument will set \*(L"eating\*(R" to on or off
appropriately, depending on whether the value is true or false.
.SH "AUTHOR"
.IX Header "AUTHOR"
Chris 'BinGOs' Williams
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1CTCP\s0 Specification <http://www.irchelp.org/irchelp/rfc/ctcpspec.html>.