Mercurial > irccd

comparison plugins/plugin/plugin.md @ 0:1158cffe5a5e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial import
author David Demelier <markand@malikania.fr>
date Mon, 08 Feb 2016 16:43:14 +0100
parents
children 798093d4c176
comparison
equal deleted inserted replaced
-1:000000000000 0:1158cffe5a5e
1 ---
2 title: "Plugin plugin"
3 header: "Plugin plugin"
4 ---
5
6 The plugin **plugin** let you inspect loaded plugins.
7
8 ## Installation
9
10 The plugin **plugin** is distributed with irccd. To enable it add the following to your **plugins** section:
11
12 ````ini
13 [plugins]
14 plugin = ""
15 ````
16
17 ## Usage
18
19 The plugin **plugin** only reacts to the special command. It understands `info` and `list` sub commands.
20
21 - The sub command `info` shows information about a plugin,
22 - The sub command `list` shows loaded plugins.
23
24 Both commands work in a channel or as private message with irccd.
25
26 ## Configuration
27
28 You can use different formats.
29
30 The following options are available under the `[plugin.plugin]` section:
31
32 - **format-usage**: (string) message to show on invalid usage,
33 - **format-info**: (string) plugin information message to show,
34 - **format-not-found**: (string) message to show if a plugin does not exist,
35 - **format-too-long**: (string) message to show if the list of plugin is too long.
36
37 ### Keywords supported
38
39 The following keywords are supported:
40
41 | Format | Keywords | Notes |
42 |-------------------------|-----------------------------------------|---------------------------------------------|
43 | (any) | command, nickname, origin, server | the command is the plugin invocation prefix |
44 | **format-info** | author, license, name, summary, version | the plugin information |
45 | **format-not-found** | name | the plugin name |