mirror of
https://github.com/Mikaela/Limnoria-doc.git
synced 2024-11-30 16:29:26 +01:00
154 lines
4.0 KiB
ReStructuredText
154 lines
4.0 KiB
ReStructuredText
|
|
.. _plugin-owner:
|
|
|
|
The Owner plugin
|
|
================
|
|
|
|
Plugins and commands
|
|
--------------------
|
|
|
|
.. _command-owner-load:
|
|
|
|
owner load [--deprecated] <plugin>
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Loads the plugin *<plugin>* from any of the directories in
|
|
conf.:ref:`supybot.directories.plugins`; usually this includes the main
|
|
installed directory and 'plugins' in the current directory.
|
|
*--deprecated* is necessary if you wish to load deprecated plugins.
|
|
|
|
.. _command-owner-unload:
|
|
|
|
owner unload <plugin>
|
|
^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Unloads the callback by name; use the 'list' command to see a list
|
|
of the currently loaded callbacks. Obviously, the Owner plugin can't
|
|
be unloaded.
|
|
|
|
.. _command-owner-reload:
|
|
|
|
owner reload <plugin>
|
|
^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Unloads and subsequently reloads the plugin by name; use the 'list'
|
|
command to see a list of the currently loaded plugins.
|
|
|
|
.. _command-owner-rename:
|
|
|
|
owner rename <plugin> <command> <new name>
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Renames *<command>* in *<plugin>* to the *<new name>*.
|
|
|
|
.. _command-owner-unrename:
|
|
|
|
owner unrename <plugin>
|
|
^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Removes all renames in *<plugin>*. The plugin will be reloaded after
|
|
this command is run.
|
|
|
|
.. _command-owner-enable:
|
|
|
|
owner enable [<plugin>] <command>
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Enables the command *<command>* for all users. If *<plugin>*
|
|
if given, only enables the *<command>* from *<plugin>*. This command is
|
|
the inverse of disable.
|
|
|
|
.. _command-owner-disable:
|
|
|
|
owner disable [<plugin>] <command>
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Disables the command *<command>* for all users (including the owners).
|
|
If *<plugin>* is given, only disables the *<command>* from *<plugin>*. If
|
|
you want to disable a command for most users but not for yourself, set
|
|
a default capability of -plugin.command or -command (if you want to
|
|
disable the command in all plugins).
|
|
|
|
.. _command-owner-defaultplugin:
|
|
|
|
owner defaultplugin [--remove] <command> [<plugin>]
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Sets the default plugin for *<command>* to *<plugin>*. If *--remove* is
|
|
given, removes the current default plugin for *<command>*. If no plugin
|
|
is given, returns the current default plugin set for *<command>*. See
|
|
also, :ref:`supybot.commands.defaultPlugins.importantPlugins.`
|
|
|
|
Capabilities
|
|
------------
|
|
|
|
.. _command-owner-defaultcapability:
|
|
|
|
owner defaultcapability {add|remove} <capability>
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Adds or removes (according to the first argument) *<capability>* from the
|
|
default capabilities given to users (the configuration variable
|
|
:ref:`supybot.capabilities` stores these).
|
|
|
|
Maintenance
|
|
-----------
|
|
|
|
.. _command-owner-reloadlocale:
|
|
|
|
owner reloadlocale takes no argument
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Reloads the locale of the bot.
|
|
|
|
.. _command-owner-ircquote:
|
|
|
|
owner ircquote <string to be sent to the server>
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Sends the raw string given to the server.
|
|
|
|
.. _command-owner-upkeep:
|
|
|
|
owner upkeep [<level>]
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Runs the standard upkeep stuff (flushes and gc.collects()). If given
|
|
a level, runs that level of upkeep (currently, the only supported
|
|
level is "high", which causes the bot to flush a lot of caches as well
|
|
as do normal upkeep stuff.
|
|
|
|
.. _command-owner-flush:
|
|
|
|
owner flush
|
|
^^^^^^^^^^^
|
|
|
|
Runs all the periodic flushers in world.flushers. This includes
|
|
flushing all logs and all configuration changes to disk.
|
|
|
|
.. _command-owner-quit:
|
|
|
|
owner quit [<text>]
|
|
^^^^^^^^^^^^^^^^^^^
|
|
|
|
Exits the bot with the QUIT message *<text>*. If *<text>* is not given,
|
|
the default quit message (:ref:`supybot.plugins.Owner.quitMsg`) will be used.
|
|
If there is no default quitMsg set, your nick will be used.
|
|
|
|
.. _command-owner-announce:
|
|
|
|
owner announce <text>
|
|
^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Sends *<text>* to all channels the bot is currently on and not
|
|
lobotomized in.
|
|
|
|
.. _command-owner-logmark:
|
|
|
|
owner logmark <text>
|
|
^^^^^^^^^^^^^^^^^^^^
|
|
|
|
Logs *<text>* to the global Supybot log at critical priority. Useful for
|
|
marking logfiles for later searching.
|
|
|