Mercurial > irccd
annotate man/irccd-api.3 @ 1089:16e66403ea66
plugins: substitute IRCCD_VERSION in Javascript plugins
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 21 Jul 2021 15:33:17 +0200 |
parents | cf99df45cb84 |
children | f06e9761cc90 |
rev | line source |
---|---|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 .\" |
1018
cf99df45cb84
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
1009
diff
changeset
|
2 .\" Copyright (c) 2013-2021 David Demelier <markand@malikania.fr> |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 .\" |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 .\" Permission to use, copy, modify, and/or distribute this software for any |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 .\" purpose with or without fee is hereby granted, provided that the above |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 .\" copyright notice and this permission notice appear in all copies. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 .\" |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 .\" |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 .Dd @IRCCD_MAN_DATE@ |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 .Dt IRCCD-API 7 |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 .Os |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 .\" NAME |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 .Sh NAME |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 .Nm irccd-api |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 .Nd irccd Javascript API |
866
0a9b03e5239e
doc: improve irccd-api.7 wording
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
23 .\" SYNOPSIS |
0a9b03e5239e
doc: improve irccd-api.7 wording
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
24 .Sh SYNOPSIS |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
25 .Ss Modules |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
26 .Vt Irccd |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
27 .Vt Irccd.Chrono |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
28 .Vt Irccd.Directory |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
29 .Vt Irccd.File |
1002
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
932
diff
changeset
|
30 .Vt Irccd.Hook |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
31 .Vt Irccd.Logger |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
32 .Vt Irccd.Plugin |
1002
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
932
diff
changeset
|
33 .Vt Irccd.Rule |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
34 .Vt Irccd.Server |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
35 .Vt Irccd.System |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
36 .Vt Irccd.Timer |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
37 .Vt Irccd.Unicode |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
38 .Vt Irccd.Util |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
39 .Ss Events |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
40 .Fn onCommand "server, origin, channel, message" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
41 .Fn onConnect "server" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
42 .Fn onDisonnect "server" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
43 .Fn onInvite "server, origin, channel" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
44 .Fn onJoin "server, origin, channel" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
45 .Fn onKick "server, origin, channel, target, reason" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
46 .Fn onLoad " |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
47 .Fn onMe "server, origin, channel, message" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
48 .Fn onMessage "server, origin, channel, message" |
1004
3ea3361f0fc7
irccd: now track modes
David Demelier <markand@malikania.fr>
parents:
1002
diff
changeset
|
49 .Fn onMode "server, origin, channel, mode, args" |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
50 .Fn onNames "server, channel, list" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
51 .Fn onNick "server, origin, nickname" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
52 .Fn onNotice "server, origin, notice" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
53 .Fn onPart "server, origin, channel, reason" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
54 .Fn onReload " |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
55 .Fn onTopic "server, origin, channel, topic" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
56 .Fn onUnload " |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
57 .Fn onWhois "server, info" |
866
0a9b03e5239e
doc: improve irccd-api.7 wording
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
58 .El |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 .\" DESCRIPTION |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 .Sh DESCRIPTION |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 This documentation shows the API reference for the official irccd Javascript |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 API. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 Any function that is indicated as |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 .Em optional |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 in square brackets means it may not exist on your platform. A quick check in |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 Javascript will let you test its presence. |
1009
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
68 .Pp |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
69 An example of plugin can be found at |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
70 .Pa @CMAKE_INSTALL_FULL_DATADIR@/irccd/sample-plugin.js |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
71 .\" INFO |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
72 .Sh INFO |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
73 The global |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
74 .Vt info |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
75 object in the plugin can contain the following strings which identifies the |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
76 plugin information: |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
77 .Bl -tag |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
78 .It Vt license |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
79 Plugin license. |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
80 .It Vt version |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
81 Arbitraty version. |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
82 .It Vt author |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
83 Author. |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
84 .It Vt summary |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
85 A short description about the plugin. |
637a98de3910
misc: add more examples
David Demelier <markand@malikania.fr>
parents:
1004
diff
changeset
|
86 .El |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
87 .\" EVENTS |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
88 .Sh EVENTS |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
89 The following is a list of events that Javascript plugins support. All functions |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
90 are completely optional and may be omitted. If you want to support a function |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
91 just implement it as global Javascript function. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
92 .\" onCommand |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
93 .Ss onCommand |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
94 Special commands are not real IRC events. They are called from channel messages |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
95 with a specific syntax using a delimiter and the plugin name. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
96 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
97 For instance, with default irccd parameters, saying on a channel |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
98 .Ar "!ask foo" |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
99 will call the special command of the plugin named |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
100 .Nm ask . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
101 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
102 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
103 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
104 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
105 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
106 .It Fa origin No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
107 Who invoked the command. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
108 .It Fa channel No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
109 The channel where the message comes from. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
110 .It Fa message No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
111 The real message, without the ! part. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
112 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
113 .\" onConnect |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
114 .Ss onConnect |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
115 This callback is called when the irccd instance successfully connect to a |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
116 server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
117 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
118 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
119 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
120 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
121 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
122 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
123 .\" onDisconnect |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
124 .Ss onDisconnect |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
125 This callback is called when a server has been disconnected by any way. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
126 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
127 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
128 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
129 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
130 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
131 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
132 .\" onInvite |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
133 .Ss onInvite |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
134 This event is called when someone is inviting you to a channel. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
135 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
136 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
137 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
138 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
139 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
140 .It Fa origin No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
141 Who invited you. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
142 .It Fa channel No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
143 On which channel you are invited to. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
144 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
145 .\" onJoin |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
146 .Ss onJoin |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
147 User join events, this function is called when someone joins a channel. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
148 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
149 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
150 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
151 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
152 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
153 .It Fa origin No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
154 The person who joined the channel. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
155 .It Fa channel No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
156 The channel the user has joined. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
157 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
158 .\" onKick |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
159 .Ss onKick |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
160 This event is triggered when someone has been kicked from a channel. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
161 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
162 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
163 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
164 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
165 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
166 .It Fa origin No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
167 Who kicked the person. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
168 .It Fa channel No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
169 The channel. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
170 .It Fa target No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
171 The kicked person. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
172 .It Fa reason No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
173 An optional reason. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
174 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
175 .\" onLoad |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
176 .Ss onLoad |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
177 This function is called when irccd instance load a plugin. If this function |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
178 throws an error, the script is not loaded. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
179 .\" onMe |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
180 .Ss onMe |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
181 Action emote. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
182 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
183 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
184 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
185 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
186 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
187 .It Fa origin No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
188 The person who said something. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
189 .It Fa channel No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
190 The channel. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
191 .It Fa message No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
192 The message sent. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
193 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
194 .\" onMessage |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
195 .Ss onMessage |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
196 This event is triggered when someone said something on a specific channel. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
197 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
198 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
199 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
200 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
201 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
202 .It Fa origin No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
203 The person who said something. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
204 .It Fa channel No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
205 The channel. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
206 .It Fa message No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
207 The message sent. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
208 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
209 .\" onMode |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
210 .Ss onMode |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
211 This event is triggered when the server changed a channel mode or your mode. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
212 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
213 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
214 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
215 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
216 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
217 .It Fa origin No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
218 The person who changed the mode. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
219 .It Fa mode No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
220 The new mode. |
1004
3ea3361f0fc7
irccd: now track modes
David Demelier <markand@malikania.fr>
parents:
1002
diff
changeset
|
221 .It Fa args No (array) |
3ea3361f0fc7
irccd: now track modes
David Demelier <markand@malikania.fr>
parents:
1002
diff
changeset
|
222 List of mode arguments as strings. |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
223 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
224 .\" onNames |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
225 .Ss onNames |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
226 This event is triggered when a list of names has come. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
227 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
228 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
229 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
230 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
231 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
232 .It Fa channel No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
233 Which channel. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
234 .It Fa list No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
235 A sequence with all users. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
236 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
237 .\" onNick |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
238 .Ss onNick |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
239 This event is triggered when someone changed its nickname. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
240 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
241 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
242 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
243 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
244 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
245 .It Fa origin No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
246 The old nickname. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
247 .It Fa nickname No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
248 The new nickname. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
249 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
250 .\" onNotice |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
251 .Ss onNotice |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
252 This event is triggered when someone sent a notice to you. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
253 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
254 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
255 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
256 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
257 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
258 .It Fa origin No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
259 The one who sent the notice. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
260 .It Fa message No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
261 The notice message. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
262 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
263 .\" onPart |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
264 .Ss onPart |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
265 This event is triggered when someone has left a specific channel. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
266 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
267 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
268 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
269 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
270 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
271 .It Fa origin No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
272 The person who left the channel. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
273 .It Fa channel No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
274 The channel. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
275 .It Fa reason No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
276 An optional reason. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
277 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
278 .\" onReload |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
279 .Ss onReload |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
280 Request to reload the plugin. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
281 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
282 This function does nothing in the irccd internals, it just calls a function that |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
283 you can use to reload some data. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
284 .\" onTopic |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
285 .Ss onTopic |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
286 This event is triggered when someone changed the channel's topic. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
287 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
288 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
289 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
290 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
291 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
292 .It Fa origin No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
293 The person who changed the topic. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
294 .It Fa channel No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
295 The channel. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
296 .It Fa topic No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
297 The new topic (may be empty). |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
298 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
299 .\" onUnload |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
300 .Ss onUnload |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
301 This event is triggered when the plugin is about to be unloaded. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
302 .\" onWhois |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
303 .Ss onWhois |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
304 This event is triggered when irccd gets information about a user. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
305 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
306 Arguments |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
307 .Bl -tag -width 20n -compact -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
308 .It Fa server No (Server) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
309 The current server. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
310 .It Fa info No (Object) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
311 The whois information. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
312 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
313 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
314 The |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
315 .Fa info |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
316 is an object with the following properties: |
1004
3ea3361f0fc7
irccd: now track modes
David Demelier <markand@malikania.fr>
parents:
1002
diff
changeset
|
317 .Bl -tag -width "nickname (string)" |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
318 .It Fa nickname No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
319 The user nickname. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
320 .It Fa user No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
321 The user name. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
322 .It Fa host No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
323 The hostname. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
324 .It Fa realname No (string) |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
325 The real name used. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
326 .It Fa channels No (array) |
1004
3ea3361f0fc7
irccd: now track modes
David Demelier <markand@malikania.fr>
parents:
1002
diff
changeset
|
327 An optional list of channels joined by the user. Objects in the array are |
3ea3361f0fc7
irccd: now track modes
David Demelier <markand@malikania.fr>
parents:
1002
diff
changeset
|
328 defined using the following properties: |
3ea3361f0fc7
irccd: now track modes
David Demelier <markand@malikania.fr>
parents:
1002
diff
changeset
|
329 .Bl -tag -width "name (string)" |
3ea3361f0fc7
irccd: now track modes
David Demelier <markand@malikania.fr>
parents:
1002
diff
changeset
|
330 .It Fa name No (string) |
3ea3361f0fc7
irccd: now track modes
David Demelier <markand@malikania.fr>
parents:
1002
diff
changeset
|
331 The name of the channel. |
3ea3361f0fc7
irccd: now track modes
David Demelier <markand@malikania.fr>
parents:
1002
diff
changeset
|
332 .It Fa modes No (int) |
3ea3361f0fc7
irccd: now track modes
David Demelier <markand@malikania.fr>
parents:
1002
diff
changeset
|
333 A bitwise mask of modes applied the user has on this channel. |
3ea3361f0fc7
irccd: now track modes
David Demelier <markand@malikania.fr>
parents:
1002
diff
changeset
|
334 .El |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
335 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
336 .\" MODULES |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
337 .Sh MODULES |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
338 The following modules are part of the official Javascript API. They are all |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
339 accessible as global function, variables and objects. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
340 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
341 All modules are categorized into pseudo namespaces that are placed into the |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
342 global |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
343 .Va Irccd |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
344 object. (e.g. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
345 .Va Irccd.Directory , Irccd.File ) . |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
346 See dedicated manual pages for information of all submodules. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
347 .\" CONSTANTS |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
348 .Sh CONSTANTS |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
349 .\" Constants |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
350 The following constants properties are defined: |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
351 .Pp |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
352 .Bl -tag |
1002
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
932
diff
changeset
|
353 .It Va Irccd.Version No (object) |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
354 See below. |
1002
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
932
diff
changeset
|
355 .It Va Irccd.Version.Major No (int) |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
356 The major irccd version. |
1002
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
932
diff
changeset
|
357 .It Va Irccd.Version.Minor No (int) |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
358 The minor irccd version. |
1002
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
932
diff
changeset
|
359 .It Va Irccd.Version.Patch No (int) |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
360 The patch irccd version. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
361 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
362 .Pp |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
363 .\" EXCEPTIONS |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
364 .Sh EXCEPTIONS |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
365 The following exceptions are defined: |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
366 .Bl -tag |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
367 .It Va Irccd.SystemError |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
368 An exception inheriting Error thrown by some filesystem functions. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
369 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
370 .\" SEE ALSO |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
371 .Sh SEE ALSO |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
372 .Xr irccd 1 |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
373 .Xr irccd-api-chrono 3 , |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
374 .Xr irccd-api-directory 3 , |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
375 .Xr irccd-api-file 3 , |
1002
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
932
diff
changeset
|
376 .Xr irccd-api-hook 3 , |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
377 .Xr irccd-api-logger 3 , |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
378 .Xr irccd-api-plugin 3 , |
1002
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
932
diff
changeset
|
379 .Xr irccd-api-rule 3 , |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
380 .Xr irccd-api-server 3 , |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
381 .Xr irccd-api-system 3 , |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
382 .Xr irccd-api-timer 3 , |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
383 .Xr irccd-api-unicode 3 , |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
913
diff
changeset
|
384 .Xr irccd-api-util 3 |