Mercurial > irccd
annotate plugins/plugin/plugin.md @ 531:d71c59eb04c3
Common: add string_util namespace
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 16 Nov 2017 23:55:19 +0100 |
parents | f1414576ceaa |
children | ebe561276c33 |
rev | line source |
---|---|
0 | 1 --- |
2 title: "Plugin plugin" | |
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 | 5 --- |
6 | |
7 The plugin **plugin** let you inspect loaded plugins. | |
8 | |
9 ## Installation | |
10 | |
11 The plugin **plugin** is distributed with irccd. To enable it add the following to your **plugins** section: | |
12 | |
13 ````ini | |
14 [plugins] | |
15 plugin = "" | |
16 ```` | |
17 | |
18 ## Usage | |
19 | |
20 The plugin **plugin** only reacts to the special command. It understands `info` and `list` sub commands. | |
21 | |
22 - The sub command `info` shows information about a plugin, | |
420
f1414576ceaa
Plugin plugin: enable configurable limits, closes #618
David Demelier <markand@malikania.fr>
parents:
275
diff
changeset
|
23 - The sub command `list` shows loaded plugins (see configuration for limits). |
0 | 24 |
25 Both commands work in a channel or as private message with irccd. | |
26 | |
27 ## Configuration | |
28 | |
29 The following options are available under the `[plugin.plugin]` section: | |
30 | |
420
f1414576ceaa
Plugin plugin: enable configurable limits, closes #618
David Demelier <markand@malikania.fr>
parents:
275
diff
changeset
|
31 - **max-list-lines**: (int) max number of lines allowed for the `list` sub |
f1414576ceaa
Plugin plugin: enable configurable limits, closes #618
David Demelier <markand@malikania.fr>
parents:
275
diff
changeset
|
32 command (Optional, default: 3), |
f1414576ceaa
Plugin plugin: enable configurable limits, closes #618
David Demelier <markand@malikania.fr>
parents:
275
diff
changeset
|
33 - **max-list-columns**: (int) max number of columns allowed per lines |
f1414576ceaa
Plugin plugin: enable configurable limits, closes #618
David Demelier <markand@malikania.fr>
parents:
275
diff
changeset
|
34 (Optional, default: 80). |
f1414576ceaa
Plugin plugin: enable configurable limits, closes #618
David Demelier <markand@malikania.fr>
parents:
275
diff
changeset
|
35 |
145
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
36 **Deprecated in irccd 2.1.0:** |
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 - **format-usage**: Use `[format.plugin] usage` instead, |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
39 - **format-info**: Use `[format.plugin] info` instead, |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
40 - **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
|
41 - **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
|
42 |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
43 ## Formats |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
44 |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
45 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
|
46 |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
47 - **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
|
48 - **info**: (string) plugin information message to show, |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
49 - **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
|
50 - **too-long**: (string) message to show if the list of plugin is too long. |
0 | 51 |
52 ### Keywords supported | |
53 | |
54 The following keywords are supported: | |
55 | |
145
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
56 | Format | Keywords | Notes | |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
57 |---------------|----------------------------------------------------|---------------------------------------------| |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
58 | (any) | channel, command, nickname, origin, plugin, server | | |
410f71eb9237
Plugin plugin: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
47
diff
changeset
|
59 | **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
|
60 | **not-found** | name | the plugin name | |