Admin
Documentation for the Admin plugin for Supybot
Purpose
These are commands useful for administrating the bot; they all require
their caller to have the admin capability. This plugin is loaded by
default.
Commands
- capability add <name|hostmask> <capability>
Gives the user specified by <name> (or the user to whom <hostmask> currently maps) the specified capability <capability>
- capability remove <name|hostmask> <capability>
Takes from the user specified by <name> (or the user to whom <hostmask> currently maps) the specified capability <capability>
- channels takes no arguments
Returns the channels the bot is on. Must be given in private, in order to protect the secrecy of secret channels.
- ignore add <hostmask|nick> [<expires>]
Ignores <hostmask> or, if a nick is given, ignores whatever hostmask that nick is currently using. <expires> is a "seconds from now" value that determines when the ignore will expire; if, for instance, you wish for the ignore to expire in an hour, you could give an <expires> of 3600. If no <expires> is given, the ignore will never automatically expire.
- ignore list takes no arguments
Returns the hostmasks currently being globally ignored.
- ignore remove <hostmask|nick>
Ignores <hostmask> or, if a nick is given, ignores whatever hostmask that nick is currently using.
- join <channel> [<key>]
Tell the bot to join the given channel. If <key> is given, it is used when attempting to join the channel.
- nick [<nick>]
Changes the bot's nick to <nick>. If no nick is given, returns the bot's current nick.
- 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.
Configuration
- supybot.plugins.Admin.public
This config variable defaults to True and is not channel specific.
Determines whether this plugin is publicly visible.