Mercurial > irccd

comparison plugins/plugin/plugin.7 @ 845:00a4720c4874

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: rewrite documentation in manual pages, closes #1674 Get rid of markdown documentation and the custom generator tools, instead use raw manual pages.
author David Demelier <markand@malikania.fr>
date Mon, 08 Jul 2019 16:15:57 +0200
parents
children 5e25439fe98d
comparison
equal deleted inserted replaced
844:dc6b42d7b97a 845:00a4720c4874
1 .\"
2 .\" Copyright (c) 2013-2019 David Demelier <markand@malikania.fr>
3 .\"
4 .\" Permission to use, copy, modify, and/or distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
7 .\"
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 .\"
16 .Dd @IRCCD_MAN_DATE@
17 .Dt IRCCD-PLUGIN-PLUGIN 7
18 .Os
19 .\" NAME
20 .Sh NAME
21 .Nm plugin
22 .Nd irccd plugin plugin
23 .\" DESCRIPTION
24 .Sh DESCRIPTION
25 The
26 .Nm
27 plugin let you inspect loaded plugins.
28 .\" INSTALLATION
29 .Sh INSTALLATION
30 The plugin
31 .Nm
32 is distributed with irccd. To enable it add the following to your plugins
33 section:
34 .Pp
35 .Bd -literal
36 [plugins]
37 plugin = ""
38 .Ed
39 .\" USAGE
40 .Sh USAGE
41 The
42 .Nm
43 plugin only reacts to the special command. It understands
44 .Ar info
45 and
46 .Ar list
47 sub commands.
48 .Pp
49 .Bl -bullet -compact
50 .It
51 The sub command
52 .Ar info
53 shows information about a plugin.
54 .It
55 The sub command
56 .Ar list
57 shows loaded plugins (see configuration for limits).
58 .El
59 .Pp
60 Both commands work in a channel or as private message with irccd.
61 .\" CONFIGURATION
62 .Sh CONFIGURATION
63 The following options are available under the
64 .Va [plugin.plugin]
65 section:
66 .Bl -tag -width 22n -offset Ds
67 .It Va max-list-lines No (int)
68 max number of lines allowed for the
69 .Ar list
70 sub command (Optional, default: 3).
71 .It Va max-list-columns No (int)
72 max number of columns allowed per lines (Optional, default: 80).
73 .\" TEMPLATES
74 .Sh TEMPLATES
75 The
76 .Nm
77 plugin supports the following templates in
78 .Va [templates.plugin]
79 section:
80 .Bl -tag -width 14n -offset Ds
81 .It Va usage
82 Message to show on invalid usage.
83 .It Va info
84 Plugin information message to show. Keywords:
85 .Em author , license , name , summary , version .
86 .It Va not-found
87 Message to show if a plugin does not exist. Keywords:
88 .Em name .
89 .It Va too-long
90 Message to show if the list of plugin is too long.
91 .El
92 .Pp
93 All templates support the following standard keywords:
94 .Em channel , command , nickname , origin , plugin , server.
95 .\" SEE ALSO
96 .Sh SEE ALSO
97 .Xr irccd 1 ,
98 .Xr irccd-templates 7