Mercurial > irccd

annotate plugins/plugin/plugin.md @ 275:c143682678b9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
CMake: improve documentation related to plugins
author David Demelier <markand@malikania.fr>
date Thu, 29 Sep 2016 12:41:19 +0200
parents 410f71eb9237
children f1414576ceaa
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"
275
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 145
diff changeset
4 guide: yes
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 The plugin **plugin** let you inspect loaded plugins.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 ## Installation
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 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
12
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 [plugins]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 plugin = ""
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 ## Usage
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 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
21
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 - The sub command `info` shows information about a plugin,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 - The sub command `list` shows loaded plugins.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 Both commands work in a channel or as private message with irccd.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 ## Configuration
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 The following options are available under the `[plugin.plugin]` section:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
145
410f71eb9237 Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
31 **Deprecated in irccd 2.1.0:**
410f71eb9237 Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
32
410f71eb9237 Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
33 - **format-usage**: Use `[format.plugin] usage` instead,
410f71eb9237 Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
34 - **format-info**: Use `[format.plugin] info` instead,
410f71eb9237 Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
35 - **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
36 - **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
37
410f71eb9237 Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
38 ## Formats
410f71eb9237 Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
39
410f71eb9237 Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
40 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
41
410f71eb9237 Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
42 - **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
43 - **info**: (string) plugin information message to show,
410f71eb9237 Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
44 - **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
45 - **too-long**: (string) message to show if the list of plugin is too long.
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 ### Keywords supported
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 The following keywords are supported:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50
145
410f71eb9237 Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
51 | Format | Keywords | Notes |
410f71eb9237 Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
52 |---------------|----------------------------------------------------|---------------------------------------------|
410f71eb9237 Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
53 | (any) | channel, command, nickname, origin, plugin, server | |
410f71eb9237 Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents: 47
diff changeset
54 | **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
55 | **not-found** | name | the plugin name |