Limnoria-doc/use/plugins/admin.rst

110 lines
2.3 KiB
ReStructuredText
Raw Normal View History

2011-06-28 08:11:32 +02:00
.. _plugin-admin:
The Admin plugin
================
2011-06-28 17:29:38 +02:00
Capabilities
------------
2011-06-29 19:17:50 +02:00
.. _command-admin-capability-add:
2011-06-28 17:29:38 +02:00
capability add <name|hostmask> <capability>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gives the user specified by *<name>* (or the user to whom *<hostmask>*
currently maps) the specified capability *<capability>*
2011-06-29 19:17:50 +02:00
.. _command-admin-capability-remove:
2011-06-28 17:29:38 +02:00
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
--------
2011-06-29 19:17:50 +02:00
.. _command-admin-channels:
2011-06-28 08:11:32 +02:00
channels
^^^^^^^^
Returns the channels the bot is on. Must be given in private, in order
to protect the secrecy of secret channels.
2011-06-29 19:17:50 +02:00
.. _command-admin-join:
2011-06-28 17:29:38 +02:00
join <channel> [<key>]
^^^^^^^^^^^^^^^^^^^^^^
Tell the bot to join the given channel. If *<key>* is given, it is used
when attempting to join the channel.
2011-06-28 08:11:32 +02:00
2011-06-29 19:17:50 +02:00
.. _command-admin-part:
2011-06-28 08:11:32 +02:00
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.
2011-06-28 17:29:38 +02:00
Ignores
-------
2011-06-28 08:11:32 +02:00
2011-06-29 19:17:50 +02:00
.. _command-admin-ignore-list:
2011-06-28 08:11:32 +02:00
ignore list
^^^^^^^^^^^
Lists the hostmasks that the bot is ignoring.
2011-06-29 19:17:50 +02:00
.. _command-admin-ignore-remove:
2011-06-28 08:11:32 +02:00
ignore remove <hostmask|nick>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This will remove the persistent ignore on *<hostmask>* or the
hostmask currently associated with *<nick>*.
2011-06-29 19:17:50 +02:00
.. _command-admin-ignore-add:
2011-06-28 08:11:32 +02:00
ignore add <hostmask|nick> [<expires>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
2011-06-28 17:29:38 +02:00
Miscellaneous
-------------
2011-06-28 08:11:32 +02:00
2011-06-29 19:17:50 +02:00
.. _command-admin-nick:
2011-06-28 08:11:32 +02:00
nick [<nick>]
^^^^^^^^^^^^^
Changes the bot's nick to *<nick>*. If no nick is given, returns the
bot's current nick.
.. _plugin-admin-config:
Configuration
-------------
.. _supybot.plugins.Admin.public:
supybot.plugins.Admin.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.