Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-14 06:39:23 +01:00
Code Issues Projects Releases Wiki Activity
dd3678e481
Limnoria/plugins/Status
History
Valentin Lorentz 63eb6672ea Revert generic 'The Limnoria Contributors' in copyright notices 
This commit reverts db7ef3f025
(though it keeps the year updates)

After discussion with several people, it seems better to mention
copyright owners explicitly. eg. https://reuse.software/faq/#vcs-copyright
explains the issue of using VCSs to track copyright.

As db7ef3f025 only replaced mentions
of my name with 'The Limnoria Contributors', this commit only needs
to undo that + add one person who contributed to setup.py.
2021-10-17 09:57:55 +02:00
..
locales Fix msgfmt warnings. 2020-03-26 22:10:28 +01:00
__init__.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00
config.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00
messages.pot Squashed commit of the following: 2014-12-20 14:37:27 +01:00
plugin.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00
README.rst all plugins: regenerate READMEs 2021-04-22 00:29:15 +02:00
test.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00

README.rst

Documentation for the Status plugin for Supybot

Purpose

A simple module to handle various informational commands querying the bot's current status and statistics, like its uptime.

Usage

This plugin allows you to view different bot statistics, for example, uptime.

Commands

cmd takes no arguments

Returns some interesting command-related statistics.

commands takes no arguments

Returns a list of the commands offered by the bot.

cpu takes no arguments

Returns some interesting CPU-related statistics on the bot.

net takes no arguments

Returns some interesting network-related statistics.

network takes no arguments

Returns the network the bot is on.

processes takes no arguments

Returns the number of processes that have been spawned, and list of ones that are still active.

server takes no arguments

Returns the server the bot is on.

status takes no arguments

Returns the status of the bot.

threads takes no arguments

Returns the current threads that are active.

uptime takes no arguments

Returns the amount of time the bot has been running.

Configuration

supybot.plugins.Status.cpu

This is a group of:

supybot.plugins.Status.cpu.children

This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether the cpu command will list the time taken by children as well as the bot's process.

supybot.plugins.Status.cpu.memory

This config variable defaults to "True", is network-specific, and is channel-specific.

Determines whether the cpu command will report the amount of memory being used by the bot.

supybot.plugins.Status.cpu.threads

This config variable defaults to "False", is network-specific, and is channel-specific.

Determines whether the cpu command will provide the number of threads spawned and active.

supybot.plugins.Status.public

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

Determines whether this plugin is publicly visible.