Limnoria-doc/use/plugins/plugin.rst

79 lines
1.5 KiB
ReStructuredText
Raw Normal View History

2011-06-28 08:11:32 +02:00
.. _plugin-plugin:
The Plugin plugin
=================
2011-06-28 17:29:38 +02:00
Authorship
----------
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
.. _command-plugin-contributors:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
plugin contributors <plugin> [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
Replies with a list of people who made contributions to a given plugin.
If *<nick>* is specified, that person's specific contributions will
be listed. Note: The *<nick>* is the part inside of the parentheses
in the people listing.
2011-06-28 17:29:38 +02:00
.. _command-plugin-author:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
plugin author <plugin>
^^^^^^^^^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
Returns the author of *<plugin>*. This is the person you should talk to
if you have ideas, suggestions, or other comments about a given plugin.
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
Help
----
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
.. _command-plugin-help:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
plugin help <plugin>
^^^^^^^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
Returns a useful description of how to use *<plugin>*, if the plugin has
one.
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
.. _command-plugin-plugin:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
plugin plugin <command>
^^^^^^^^^^^^^^^^^^^^^^^
Returns the name of the plugin that would be used to call *<command>*.
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
If it is not uniquely determined, returns list of all plugins that
contain *<command>*.
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
.. _command-plugin-list:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
plugin list
^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
Returns a list of the currently loaded plugins.
2011-06-28 17:29:38 +02:00
.. _command-plugin-plugins:
2011-06-28 08:11:32 +02:00
2011-06-28 17:29:38 +02:00
plugin plugins <command>
^^^^^^^^^^^^^^^^^^^^^^^^
2011-06-28 08:11:32 +02:00
Returns the names of all plugins that contain *<command>*.
.. _plugin-plugin-config:
Configuration
-------------
.. _supybot.plugins.Plugin.public:
supybot.plugins.Plugin.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default value: True
Determines whether this plugin is publicly visible.