Limnoria-doc/use/plugins/misc.rst
2011-06-28 17:29:38 +02:00

92 lines
2.2 KiB
ReStructuredText

.. _plugin-misc:
The Misc plugin
===============
Main commands
-------------
.. _command-misc-help:
misc help [<plugin>] [<command>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This command gives a useful description of what *<command>* does.
*<plugin>* is only necessary if the command is in more than one plugin.
.. _command-misc-list:
misc list [--private] [<plugin>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lists the commands available in the given plugin. If no plugin is
given, lists the public plugins available. If *--private* is given,
lists the private plugins.
.. _command-misc-more:
misc more [<nick>]
^^^^^^^^^^^^^^^^^^
If the last command was truncated due to IRC message length
limitations, returns the next chunk of the result of the last command.
If *<nick>* is given, it takes the continuation of the last command from
*<nick>* instead of the person sending this message.
Utilities
---------
.. _command-misc-last:
misc last [--{from,in,on,with,without,regexp} <value>] [--nolimit]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the last message matching the given criteria. *--from* requires
a nick from whom the message came; *--in* requires a channel the message
was sent to; *--on* requires a network the message was sent on; *--with
requires* some string that had to be in the message; *--regexp* requires
a regular expression the message must match; *--nolimit* returns all
the messages that can be found. By default, the channel this command is
given in is searched.
.. _command-misc-ping:
misc ping
^^^^^^^^^
Checks to see if the bot is alive.
.. _command-misc-tell:
misc tell <nick> <text>
^^^^^^^^^^^^^^^^^^^^^^^
Tells the *<nick>* whatever *<text>* is. Use nested commands to your
benefit here.
Getting informations about the bot
----------------------------------
.. _command-misc-source:
misc source
^^^^^^^^^^^
Returns a URL saying where to get Supybot.
.. _command-misc-version:
misc version
^^^^^^^^^^^^
Returns the version of the current bot.
.. _command-misc-apropos:
misc apropos <string>
^^^^^^^^^^^^^^^^^^^^^
Searches for *<string>* in the commands currently offered by the bot,
returning a list of the commands containing that string.