Limnoria-doc/use/plugins/plugin.rst
2011-10-28 22:49:04 +02:00

79 lines
1.5 KiB
ReStructuredText

.. _plugin-plugin:
The Plugin plugin
=================
Authorship
----------
.. _command-plugin-contributors:
plugin contributors <plugin> [<nick>]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
.. _command-plugin-author:
plugin author <plugin>
^^^^^^^^^^^^^^^^^^^^^^
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.
Help
----
.. _command-plugin-help:
plugin help <plugin>
^^^^^^^^^^^^^^^^^^^^
Returns a useful description of how to use *<plugin>*, if the plugin has
one.
.. _command-plugin-plugin:
plugin plugin <command>
^^^^^^^^^^^^^^^^^^^^^^^
Returns the name of the plugin that would be used to call *<command>*.
If it is not uniquely determined, returns list of all plugins that
contain *<command>*.
.. _command-plugin-list:
plugin list
^^^^^^^^^^^
Returns a list of the currently loaded plugins.
.. _command-plugin-plugins:
plugin plugins <command>
^^^^^^^^^^^^^^^^^^^^^^^^
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.