Limnoria/plugins/Channel

.. _plugin-Channel:

Documentation for the Channel plugin for Supybot
================================================

Purpose
-------

Basic channel management commands.  Many of these commands require their caller
to have the #channel,op capability.  This plugin is loaded by default.

Usage
-----

This plugin provides various commands for channel management, such
as setting modes and channel-wide bans/ignores/capabilities. This is
a core Supybot plugin that should not be removed!

.. _commands-Channel:

Commands
--------

.. _command-channel-alert:

``alert [<channel>] <text>``
  Sends <text> to all the users in <channel> who have the <channel>,op capability.

.. _command-channel-ban.add:

``ban add [<channel>] <nick|hostmask> [<expires>]``
  If you have the #channel,op capability, this will effect a persistent ban from interacting with the bot on the given <hostmask> (or the current hostmask associated with <nick>). Other plugins may enforce this ban by actually banning users with matching hostmasks when they join. <expires> is an optional argument specifying when (in "seconds from now") the ban should expire; if none is given, the ban will never automatically expire. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-ban.hostmask:

``ban hostmask [<channel>] <banmask>``
  Bans the <banmask> from the <channel>.

.. _command-channel-ban.list:

``ban list [<channel>] [<mask>]``
  If you have the #channel,op capability, this will show you the current persistent bans on the <channel> that match the given mask, if any (returns all of them otherwise). Note that you can use * as a wildcard on masks and \* to match actual * in masks

.. _command-channel-ban.remove:

``ban remove [<channel>] <hostmask>``
  If you have the #channel,op capability, this will remove the persistent ban on <hostmask>. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-capability.add:

``capability add [<channel>] <nick|username> <capability> [<capability> ...]``
  If you have the #channel,op capability, this will give the <username> (or the user to whom <nick> maps) the capability <capability> in the channel. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-capability.list:

``capability list [<channel>]``
  Returns the capabilities present on the <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-capability.remove:

``capability remove [<channel>] <name|hostmask> <capability> [<capability> ...]``
  If you have the #channel,op capability, this will take from the user currently identified as <name> (or the user to whom <hostmask> maps) the capability <capability> in the channel. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-capability.set:

``capability set [<channel>] <capability> [<capability> ...]``
  If you have the #channel,op capability, this will add the channel capability <capability> for all users in the channel. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-capability.setdefault:

``capability setdefault [<channel>] {True|False}``
  If you have the #channel,op capability, this will set the default response to non-power-related (that is, not {op, halfop, voice}) capabilities to be the value you give. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-capability.unset:

``capability unset [<channel>] <capability> [<capability> ...]``
  If you have the #channel,op capability, this will unset the channel capability <capability> so each user's specific capability or the channel default capability will take precedence. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-cycle:

``cycle [<channel>] [<reason>]``
  If you have the #channel,op capability, this will cause the bot to "cycle", or PART and then JOIN the channel. <channel> is only necessary if the message isn't sent in the channel itself. If <reason> is not specified, the default part message specified in supybot.plugins.Channel.partMsg will be used. No part message will be used if neither a cycle reason nor a default part message is given.

.. _command-channel-dehalfop:

``dehalfop [<channel>] [<nick> ...]``
  If you have the #channel,op capability, this will remove half-operator privileges from all the nicks given. If no nicks are given, removes half-operator privileges from the person sending the message.

.. _command-channel-deop:

``deop [<channel>] [<nick> ...]``
  If you have the #channel,op capability, this will remove operator privileges from all the nicks given. If no nicks are given, removes operator privileges from the person sending the message.

.. _command-channel-devoice:

``devoice [<channel>] [<nick> ...]``
  If you have the #channel,op capability, this will remove voice from all the nicks given. If no nicks are given, removes voice from the person sending the message.

.. _command-channel-disable:

``disable [<channel>] [<plugin>] [<command>]``
  If you have the #channel,op capability, this will disable the <command> in <channel>. If <plugin> is provided, <command> will be disabled only for that plugin. If only <plugin> is provided, all commands in the given plugin will be disabled. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-enable:

``enable [<channel>] [<plugin>] [<command>]``
  If you have the #channel,op capability, this will enable the <command> in <channel> if it has been disabled. If <plugin> is provided, <command> will be enabled only for that plugin. If only <plugin> is provided, all commands in the given plugin will be enabled. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-halfop:

``halfop [<channel>] [<nick> ...]``
  If you have the #channel,halfop capability, this will give all the <nick>s you provide halfops. If you don't provide any <nick>s, this will give you halfops. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-iban:

``iban [<channel>] [--{exact,nick,user,host}] <nick> [<seconds>]``
  If you have the #channel,op capability, this will ban <nick> for as many seconds as you specify, otherwise (if you specify 0 seconds or don't specify a number of seconds) it will ban the person indefinitely. --exact can be used to specify an exact hostmask. You can combine the --nick, --user, and --host options as you choose. If --account is provided and the user is logged in and the network supports account bans, this will ban the user's account instead. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-ignore.add:

``ignore add [<channel>] <nick|hostmask> [<expires>]``
  If you have the #channel,op capability, this will set a persistent ignore on <hostmask> or the hostmask currently associated with <nick>. <expires> is an optional argument specifying when (in "seconds from now") the ignore will expire; if it isn't given, the ignore will never automatically expire. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-ignore.list:

``ignore list [<channel>]``
  Lists the hostmasks that the bot is ignoring on the given channel. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-ignore.remove:

``ignore remove [<channel>] <nick|hostmask>``
  If you have the #channel,op capability, this will remove the persistent ignore on <hostmask> in the channel. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-invite:

``invite [<channel>] <nick>``
  If you have the #channel,op capability, this will invite <nick> to join <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-kban:

``kban [<channel>] [--{exact,nick,user,host,account}] <nick> [<seconds>] [<reason>]``
  If you have the #channel,op capability, this will kickban <nick> for as many seconds as you specify, or else (if you specify 0 seconds or don't specify a number of seconds) it will ban the person indefinitely. --exact bans only the exact hostmask; --nick bans just the nick; --user bans just the user, and --host bans just the host You can combine the --nick, --user, and --host options as you choose. If --account is provided and the user is logged in and the network supports account bans, this will ban the user's account instead. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-key:

``key [<channel>] [<key>]``
  Sets the keyword in <channel> to <key>. If <key> is not given, removes the keyword requirement to join <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-kick:

``kick [<channel>] <nick>[, <nick>, ...] [<reason>]``
  Kicks <nick>(s) from <channel> for <reason>. If <reason> isn't given, uses the nick of the person making the command as the reason. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-limit:

``limit [<channel>] [<limit>]``
  Sets the channel limit to <limit>. If <limit> is 0, or isn't given, removes the channel limit. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-listbans:

``listbans [<channel>]``
  List all bans on the channel. If <channel> is not given, it defaults to the current channel.

.. _command-channel-lobotomy.add:

``lobotomy add [<channel>]``
  If you have the #channel,op capability, this will "lobotomize" the bot, making it silent and unanswering to all requests made in the channel. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-lobotomy.list:

``lobotomy list takes no arguments``
  Returns the channels in which this bot is lobotomized.

.. _command-channel-lobotomy.remove:

``lobotomy remove [<channel>]``
  If you have the #channel,op capability, this will unlobotomize the bot, making it respond to requests made in the channel again. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-mode:

``mode [<channel>] <mode> [<arg> ...]``
  Sets the mode in <channel> to <mode>, sending the arguments given. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-moderate:

``moderate [<channel>]``
  Sets +m on <channel>, making it so only ops and voiced users can send messages to the channel. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-nicks:

``nicks [<channel>] [--count]``
  Returns the nicks in <channel>. <channel> is only necessary if the message isn't sent in the channel itself. Returns only the number of nicks if --count option is provided.

.. _command-channel-op:

``op [<channel>] [<nick> ...]``
  If you have the #channel,op capability, this will give all the <nick>s you provide ops. If you don't provide any <nick>s, this will op you. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-part:

``part [<channel>] [<reason>]``
  Tells the bot to part the list of channels you give it. <channel> is only necessary if you want the bot to part a channel other than the current channel. If <reason> is specified, use it as the part message. Otherwise, the default part message specified in supybot.plugins.Channel.partMsg will be used. No part message will be used if no default is configured.

.. _command-channel-unban:

``unban [<channel>] [<hostmask|--all>]``
  Unbans <hostmask> on <channel>. If <hostmask> is not given, unbans any hostmask currently banned on <channel> that matches your current hostmask. Especially useful for unbanning yourself when you get unexpectedly (or accidentally) banned from the channel. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-unmoderate:

``unmoderate [<channel>]``
  Sets -m on <channel>, making it so everyone can send messages to the channel. <channel> is only necessary if the message isn't sent in the channel itself.

.. _command-channel-voice:

``voice [<channel>] [<nick> ...]``
  If you have the #channel,voice capability, this will voice all the <nick>s you provide. If you don't provide any <nick>s, this will voice you. <channel> is only necessary if the message isn't sent in the channel itself.

.. _conf-Channel:

Configuration
-------------

.. _conf-supybot.plugins.Channel.alwaysRejoin:


supybot.plugins.Channel.alwaysRejoin
  This config variable defaults to "True", is network-specific, and is channel-specific.

  Determines whether the bot will always try to rejoin a channel whenever it's kicked from the channel.

.. _conf-supybot.plugins.Channel.nicksInPrivate:


supybot.plugins.Channel.nicksInPrivate
  This config variable defaults to "True", is network-specific, and is channel-specific.

  Determines whether the output of 'nicks' will be sent in private. This prevents mass-highlights of a channel's users, accidental or on purpose.

.. _conf-supybot.plugins.Channel.partMsg:


supybot.plugins.Channel.partMsg
  This config variable defaults to "Limnoria $version", is network-specific, and is channel-specific.

  Determines what part message should be used by default. If the part command is called without a part message, this will be used. If this value is empty, then no part message will be used (they are optional in the IRC protocol). The standard substitutions ($version, $nick, etc.) are all handled appropriately.

.. _conf-supybot.plugins.Channel.public:


supybot.plugins.Channel.public
  This config variable defaults to "True", is not network-specific, and is not channel-specific.

  Determines whether this plugin is publicly visible.

.. _conf-supybot.plugins.Channel.rejoinDelay:


supybot.plugins.Channel.rejoinDelay
  This config variable defaults to "0", is network-specific, and is channel-specific.

  Determines how many seconds the bot will wait before rejoining a channel if kicked and supybot.plugins.Channel.alwaysRejoin is on.