Mercurial > irccd
annotate plugins/plugin/plugin.md @ 254:93a227277786
Irccd: various fixes for further cross-compilation
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 05 Sep 2016 12:53:13 +0200 |
parents | 410f71eb9237 |
children | c143682678b9 |
rev | line source |
---|---|
0 | 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 The following options are available under the `[plugin.plugin]` section: | |
29 | |
145
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
30 **Deprecated in irccd 2.1.0:** |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
31 |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
32 - **format-usage**: Use `[format.plugin] usage` instead, |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
33 - **format-info**: Use `[format.plugin] info` instead, |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
34 - **format-not-found**: Use `[format.plugin] not-found` instead, |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
35 - **format-too-long**: Use `[format.plugin] too-long` instead, |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
36 |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
37 ## Formats |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
38 |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
39 The **plugin** plugin supports the following formats in `[format.plugin]` section: |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
40 |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
41 - **usage**: (string) message to show on invalid usage, |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
42 - **info**: (string) plugin information message to show, |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
43 - **not-found**: (string) message to show if a plugin does not exist, |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
44 - **too-long**: (string) message to show if the list of plugin is too long. |
0 | 45 |
46 ### Keywords supported | |
47 | |
48 The following keywords are supported: | |
49 | |
145
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
50 | Format | Keywords | Notes | |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
51 |---------------|----------------------------------------------------|---------------------------------------------| |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
52 | (any) | channel, command, nickname, origin, plugin, server | | |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
53 | **info** | author, license, name, summary, version | the plugin information | |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
54 | **not-found** | name | the plugin name | |