Mercurial > irccd
diff plugins/plugin/plugin.md @ 0:1158cffe5a5e
Initial import
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 08 Feb 2016 16:43:14 +0100 |
parents | |
children | 798093d4c176 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/plugins/plugin/plugin.md Mon Feb 08 16:43:14 2016 +0100 @@ -0,0 +1,45 @@ +--- +title: "Plugin plugin" +header: "Plugin plugin" +--- + +The plugin **plugin** let you inspect loaded plugins. + +## Installation + +The plugin **plugin** is distributed with irccd. To enable it add the following to your **plugins** section: + +````ini +[plugins] +plugin = "" +```` + +## Usage + +The plugin **plugin** only reacts to the special command. It understands `info` and `list` sub commands. + + - The sub command `info` shows information about a plugin, + - The sub command `list` shows loaded plugins. + +Both commands work in a channel or as private message with irccd. + +## Configuration + +You can use different formats. + +The following options are available under the `[plugin.plugin]` section: + + - **format-usage**: (string) message to show on invalid usage, + - **format-info**: (string) plugin information message to show, + - **format-not-found**: (string) message to show if a plugin does not exist, + - **format-too-long**: (string) message to show if the list of plugin is too long. + +### Keywords supported + +The following keywords are supported: + +| Format | Keywords | Notes | +|-------------------------|-----------------------------------------|---------------------------------------------| +| (any) | command, nickname, origin, server | the command is the plugin invocation prefix | +| **format-info** | author, license, name, summary, version | the plugin information | +| **format-not-found** | name | the plugin name |