Limnoria-doc/use/plugins/status.rst

118 lines
1.9 KiB
ReStructuredText
Raw Normal View History

2011-06-28 08:11:32 +02:00
.. _plugin-status:
The Status plugin
=================
Commands
--------
2011-06-28 17:29:38 +02:00
.. _command-status-status:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
status status
^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
Returns the status of the bot.
2011-06-28 17:29:38 +02:00
.. _command-status-cmd:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
status cmd
^^^^^^^^^^
2011-06-28 08:11:32 +02:00
Returns some interesting command-related statistics.
2011-06-28 17:29:38 +02:00
.. _command-status-commands:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
status commands
^^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
Returns a list of the commands offered by the bot.
2011-06-28 17:29:38 +02:00
.. _command-status-uptime:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
status uptime
^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
Returns the amount of time the bot has been running.
2011-06-28 17:29:38 +02:00
.. _command-status-threads:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
status threads
^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
Returns the current threads that are active.
2011-06-28 17:29:38 +02:00
.. _command-status-net:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
status net
^^^^^^^^^^
2011-06-28 08:11:32 +02:00
Returns some interesting network-related statistics.
2011-06-28 17:29:38 +02:00
.. _command-status-server:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
status server
^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
Returns the server the bot is on.
2011-06-28 17:29:38 +02:00
.. _command-status-cpu:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
status cpu
^^^^^^^^^^
2011-06-28 08:11:32 +02:00
Returns some interesting CPU-related statistics on the bot.
.. _plugin-status-config:
Configuration
-------------
.. _supybot.plugins.Status.cpu:
supybot.plugins.Status.cpu
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _supybot.plugins.Status.cpu.children:
supybot.plugins.Status.cpu.children
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the cpu command will list the time taken by children as well as the bot's process.
.. _supybot.plugins.Status.cpu.memory:
supybot.plugins.Status.cpu.memory
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether the cpu command will report the amount of memory being used by the bot.
.. _supybot.plugins.Status.cpu.threads:
supybot.plugins.Status.cpu.threads
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: False
Determines whether the cpu command will provide the number of threads spawned and active.
.. _supybot.plugins.Status.public:
supybot.plugins.Status.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.