view release on metacpan or  search on metacpan

lib/POE/Component/Server/IRC/Help.pm  view on Meta::CPAN

package POE::Component::Server::IRC::Help;
$POE::Component::Server::IRC::Help::VERSION = '1.66';
use strict;
use warnings;

sub new {
    my $package = shift;
    return bless [], $package;
}

sub topic {
    my $self = shift;
    my $topic = shift || return;
    my $lines = [];

    $topic = lc $topic;
    my $method = '_' . $topic;
    return unless eval { $self->can($method) };
    push @$lines, $_ for split m!\n!, $self->$method;
    return @$lines if wantarray;
    return $lines;
}

sub _accept {
  return << 'EOT'
ACCEPT [parameter]

ACCEPT allows you to control who can send you a NOTICE or PRIVMSG
while you have user mode +g enabled.

For +g: /QUOTE ACCEPT <n!u@h>   -- Add a permitted mask
        /QUOTE ACCEPT -<n!u@h>  -- Remove a permitted mask
        /QUOTE ACCEPT *         -- List the present permitted masks
        /QUOTE ACCEPT           -- List the present permitted masks
EOT
}

sub _admin {
  return << 'EOT'
ADMIN [servername/nickname]

With no arguments, ADMIN shows the information that was set by the
administrator of the server. This information can take any form that
will fit in three lines of text but is usually a list of contacts
for the persons that run the server.

With a second argument, the administrative information for the
specified server is displayed.

See also: stats
EOT
}

sub _away {
  return << 'EOT'
AWAY :[MSG]

Without an argument, it will set you back.  With an argument,
it will set you as AWAY with the specified message.
EOT
}

sub _close {
  return << 'EOT'
CLOSE

Close any connections from clients or servers who have
not fully registered yet.

- Requires Oper Priv: close
EOT
}

sub _cmode {
  return << 'EOT'
MODE <channel> <+|-><modes> [parameters]

=-=-=-=-=-=-=-=-=-=-=
    CHANNELMODES

lib/POE/Component/Server/IRC/Help.pm  view on Meta::CPAN

sub _topic {
  return << 'EOT'
TOPIC <#channel> :[new topic]

With only a channel argument, TOPIC shows the current topic of
the specified channel.

With a second argument, it changes the topic on that channel to
<new topic>.  If the channel is +t, only chanops may change the
topic.

See also: cmode
EOT
}

sub _trace {
  return << 'EOT'
TRACE [server | nick]

With no argument, TRACE gives a list of all clients connected
to the local server, both users and operators.

With one argument which is a server, TRACE displays the path
to the specified server, and all clients on that server.

With one argument which is a client, TRACE displays the
path to that client, and that client's information.
EOT
}

sub _umode {
  return << 'EOT'
MODE <nick> <+|-><modes>

User modes: (* designates that the umode is oper only)

     USER MODE    DESCRIPTION
-----------------------------------------------------------------
       * o     - Designates this client is an IRC Operator.
                 Use the OPER command to attain this.
         i     - Designates this client 'invisible'.
         w     - Can see server wallops.
         W     - User is connected using a webirc gateway.
       * l     - Can see oper locops (local wallops).
       * c     - Can see client connections and exits.
       * u     - Can see unauthorized client connections.
       * j     - Can see 'rejected' client notices.
       * k     - Can see server kill messages.
       * f     - Can see 'auth {} block is full' notices.
       * F     - Can see remote client connection/quit notices.
       * y     - Can see stats/links/admin requests to name a few.
       * d     - Can see server debug messages.
       * n     - Can see client nick changes.
         p     - Hides channel list in WHOIS.
         q     - Hides idle and signon time in WHOIS.
         r     - User has been registered and identified for its nick.
                 Can be set only by servers and services.
         R     - Only registered clients may message you.
         s     - Can see generic server messages and oper kills.
         S     - Client is connected via SSL/TLS.
       * e     - Can see new server introduction and split messages.
       * b     - Can see possible bot/join flood warnings.
       * a     - Is marked as a server admin in stats o/p.
         D     - "Deaf": don't receive channel messages.
         G     - "Soft Caller ID": block private messages from people not on
                 any common channels with you (unless they are accepted).
         g     - "Caller ID" mode: only allow accepted clients to message you.
       * H     - IRC operator status is hidden to other users.
EOT
}

sub _undline {
  return << 'EOT'
UNDLINE <IP address>

Will attempt to undline the given <IP address>
If the dline is conf based, the dline will not be removed.

UNDLINE <IP address> ON irc.server

Will undline the given <IP address> on irc.server if irc.server accepts
remote undlines. If the dline is conf based, the dline will
not be removed.

- Requires Oper Priv: undline
EOT
}

sub _unkline {
  return << 'EOT'
UNKLINE <user@host>

Will attempt to unkline the given <user@host>
If the kline is conf based, the kline will not be removed.

UNKLINE <user@host> ON irc.server

Will unkline the user on irc.server if irc.server accepts
remote unklines. If the kline is conf based, the kline will
not be removed.

- Requires Oper Priv: unkline
EOT
}

sub _unresv {
  return << 'EOT'
UNRESV <channel|nick>

-- Remove a RESV on a channel or nick
Will attempt to remove the resv for the given
channel/nick. If the resv is conf based, the resv
will not be removed.

UNRESV <channel|nick> ON irc.server
will unresv the <channel|nick> on irc.server if irc.server
accepts remote unresvs. If the resv is conf based, the resv
will not be removed.

- Requires Oper Priv: unresv
EOT