Files
Limnoria-doc/use/plugins/channelstats.rst
Valentin Lorentz 2ce465adcd Fix plugin docs.
2011-06-28 08:13:53 +02:00

45 lines
994 B
ReStructuredText

.. _plugin-channelstats:
The ChannelStats plugin
=======================
.. _command-stats:
stats [<channel>] [<name>]
^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the statistics for *<name>* on *<channel>*. *<channel>* is only
necessary if the message isn't sent on the channel itself. If *<name>*
isn't given, it defaults to the user sending the command.
.. _command-die:
die
^^^^
.. _command-rank:
rank [<channel>] <stat expression>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the ranking of users according to the given stat expression.
Valid variables in the stat expression include 'msgs', 'chars',
'words', 'smileys', 'frowns', 'actions', 'joins', 'parts', 'quits',
'kicks', 'kicked', 'topics', and 'modes'. Any simple mathematical
expression involving those variables is permitted.
.. _command-channelstats:
channelstats [<channel>]
^^^^^^^^^^^^^^^^^^^^^^^^
Returns the statistics for *<channel>*. *<channel>* is only necessary if
the message isn't sent on the channel itself.