Mercurial > irccd

annotate 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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 title: "Plugin plugin"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 header: "Plugin plugin"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 The plugin **plugin** let you inspect loaded plugins.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 ## Installation
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 The plugin **plugin** is distributed with irccd. To enable it add the following to your **plugins** section:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 [plugins]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 plugin = ""
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 ## Usage
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 The plugin **plugin** only reacts to the special command. It understands `info` and `list` sub commands.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 - The sub command `info` shows information about a plugin,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 - The sub command `list` shows loaded plugins.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 Both commands work in a channel or as private message with irccd.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 ## Configuration
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 You can use different formats.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 The following options are available under the `[plugin.plugin]` section:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 - **format-usage**: (string) message to show on invalid usage,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 - **format-info**: (string) plugin information message to show,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 - **format-not-found**: (string) message to show if a plugin does not exist,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 - **format-too-long**: (string) message to show if the list of plugin is too long.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 ### Keywords supported
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 The following keywords are supported:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 | Format | Keywords | Notes |
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 |-------------------------|-----------------------------------------|---------------------------------------------|
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 | (any) | command, nickname, origin, server | the command is the plugin invocation prefix |
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 | **format-info** | author, license, name, summary, version | the plugin information |
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 | **format-not-found** | name | the plugin name |