Mercurial > irccd
annotate man/libirccd-irccd.3 @ 1149:d0e522ff5143 release-4.0
plugins: substitute version, closes #2533
author | David Demelier <markand@malikania.fr> |
---|---|
date | Fri, 04 Feb 2022 10:04:04 +0100 |
parents | c165e975f144 |
children | 8278d14e7aaa |
rev | line source |
---|---|
1121
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 .\" |
1136
f06e9761cc90
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
1121
diff
changeset
|
2 .\" Copyright (c) 2013-2022 David Demelier <markand@malikania.fr> |
1121
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 .\" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 .\" Permission to use, copy, modify, and/or distribute this software for any |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 .\" purpose with or without fee is hereby granted, provided that the above |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 .\" copyright notice and this permission notice appear in all copies. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 .\" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 .\" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 .Dd @IRCCD_MAN_DATE@ |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 .Dt LIBIRCCD-IRCCD 3 |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 .Os |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 .\" NAME |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 .Sh NAME |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 .Nm libirccd-irccd |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 .Nd IRC daemon functions |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 .\" SYNOPSIS |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 .Sh SYNOPSIS |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 .In irccd/irccd.h |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 .Bd -literal |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 extern struct irc { |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 struct irc_server *servers; |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 struct irc_plugin *plugins; |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 struct irc_plugin_loader *plugin_loaders; |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 struct irc_rule *rules; |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 struct irc_hook *hooks; |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 } irc; |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 .Ed |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 .Fn irc_bot_init "void" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 .Fn irc_bot_server_add "struct irc_server *s" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 .Ft struct irc_server * |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 .Fn irc_bot_server_get "const char *id" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 .Fn irc_bot_server_remove "const char *id" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 .Fn irc_bot_server_clear "void" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 .Fn irc_bot_plugin_add "struct irc_plugin *p" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 .Ft struct irc_plugin * |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 .Fn irc_bot_plugin_find "const char *, const char *" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
50 .Ft struct irc_plugin * |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
51 .Fn irc_bot_plugin_get "const char *id" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
52 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 .Fn irc_bot_plugin_remove "const char *" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 .Fn irc_bot_plugin_clear "void" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
57 .Fn irc_bot_plugin_loader_add "struct irc_plugin_loader *ld" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 .Fn irc_bot_rule_insert "struct irc_rule *r, size_t index" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 .Ft struct irc_rule * |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 .Fn irc_bot_rule_get "size_t index" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 .Fn irc_bot_rule_move "size_t from, size_t to" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 .Fn irc_bot_rule_remove "size_t index" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 .Ft size_t |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 .Fn irc_bot_rule_size "void" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
69 .Fn irc_bot_rule_clear "void" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
71 .Fn irc_bot_hook_add "struct irc_hook *hook |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 .Ft struct irc_hook * |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 .Fn irc_bot_hook_get "const char *id" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
75 .Fn irc_bot_hook_remove "const char *id" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
76 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
77 .Fn irc_bot_hook_clear "void" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
78 .Ft size_t |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
79 .Fn irc_bot_poll_size "void" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
80 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
81 .Fn irc_bot_prepare "struct pollfd *fds" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
82 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
83 .Fn irc_bot_flush "const struct pollfd *fds" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
84 .Ft int |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
85 .Fn irc_bot_dequeue "struct irc_event *ev" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
86 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
87 .Fn irc_bot_post "void (*fn)(void *), void *data" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
88 .Ft void |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
89 .Fn irc_bot_finish "void" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
90 .\" DESCRIPTION |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
91 .Sh DESCRIPTION |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
92 This API provides routines to manipulate the daemon itself. Some of the |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
93 functions should be used with care. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
94 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
95 The global |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
96 .Vt irc |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
97 structure contains linked list of loaded elements: |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
98 .Bl -tag -width ".Va plugin_loaders" |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
99 .It Va servers |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
100 Loaded servers (see |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
101 .Xr libirccd-server 3) . |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
102 .It Va plugins |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
103 Loaded plugins (see |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
104 .Xr libirccd-plugin 3) . |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
105 .It Va plugin_loaders |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
106 Objects that search for additional plugins when required (see |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
107 .Xr libirccd-plugin 3) . |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
108 .It Va rules |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
109 Rules that filter incoming IRC events (see |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
110 .Xr libirccd-rule 3) . |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
111 .It Va hooks |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
112 Optional IRC event hooks (see |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
113 .Xr libirccd-hook 3) . |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
114 .El |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
115 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
116 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
117 .Fn irc_bot_init |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
118 function initializes the irccd globals and some of its APIs. This function does |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
119 not need to be called from plugins. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
120 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
121 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
122 .Fn irc_bot_server_add |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
123 borrows the server |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
124 .Fa s |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
125 and adds it to the daemon. It is then connected and monitored for events. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
126 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
127 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
128 .Fn irc_bot_server_get |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
129 function searches for a server with the given |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
130 .Fa id |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
131 and returns it or NULL if it does not exists. The returned server must not be |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
132 free'd nor close, use |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
133 .Fn irc_bot_server_remove |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
134 if you want to remove a server instead. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
135 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
136 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
137 .Fn irc_bot_server_clear |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
138 function disconnects and erases all servers from the daemon. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
139 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
140 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
141 .Fn irc_bot_plugin_add |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
142 function borrows the non-NULL |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
143 .Fa p |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
144 plugin and adds it to the daemon. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
145 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
146 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
147 .Fn irc_bot_plugin_find |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
148 searches through the plugin loader a plugin |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
149 .Fa id |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
150 unless a specific |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
151 .Fa path |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
152 is non-NULL. In that case it should points to an absolute file path with a |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
153 proper file extension. It then adds it to the daemon and returns it. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
154 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
155 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
156 .Fn irc_bot_plugin_get |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
157 function searches for a plugin with the given |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
158 .Fa id |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
159 and returns it or NULL if it does not exist. The returned plugin most not be |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
160 free'd nor close, use |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
161 .Fn irc_bot_plugin_remove |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
162 if you want to remove it instead. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
163 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
164 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
165 .Fn irc_bot_plugin_clear |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
166 removes all plugins currently loaded. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
167 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
168 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
169 .Fn irc_bot_plugin_loader_add |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
170 borrows the non-NULL |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
171 .Fa ld |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
172 plugin loader and adds it to the daemon. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
173 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
174 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
175 .Fn irc_bot_rule_insert |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
176 function borrows the rule |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
177 .Fa r |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
178 and insert it at the position |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
179 .Fa index. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
180 If the |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
181 .Fa index |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
182 argument is larger than the number of actual rules, it is inserted at the end. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
183 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
184 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
185 .Fn irc_bot_rule_move |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
186 function swaps the rules between |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
187 .Fa from |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
188 and |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
189 .Fa to |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
190 indices. The argument |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
191 .Fa to |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
192 can be larger than the number of actual rules, in that case the rule is moved at |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
193 the end. The argument |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
194 .Fa from |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
195 must be between 0 and |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
196 .Fn irc_bot_rule_size |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
197 minus one. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
198 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
199 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
200 .Fn irc_bot_rule_remove |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
201 function removes the rule at given |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
202 .Fa index |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
203 which must be valid. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
204 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
205 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
206 .Fn irc_bot_rule_size |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
207 returns the number of rules active. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
208 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
209 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
210 .Fn irc_bot_rule_clear |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
211 removes all rules. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
212 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
213 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
214 .Fn irc_bot_hook_add |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
215 borrows the |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
216 .Fa hook |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
217 and add it into the list. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
218 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
219 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
220 .Fn irc_bot_hook_get |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
221 function searched for a hook with the given |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
222 .Fa id |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
223 and returns it or NULL if it does not exist. The returned hook most not be |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
224 free'd nor close, use |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
225 .Fn irc_bot_hook_remove |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
226 if you want to remove it instead. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
227 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
228 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
229 .Fn irc_bot_hook_remove |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
230 removes the hook with the given |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
231 .Fa id . |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
232 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
233 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
234 .Fn irc_bot_hook_clear |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
235 removes all hooks. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
236 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
237 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
238 .Fn irc_bot_poll_size |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
239 function returns the number of file descriptors opened and listened to. It is |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
240 used in conjunction with |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
241 .Fn irc_bot_prepare |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
242 and |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
243 .Fn irc_bot_flush |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
244 to allocate a proper array of |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
245 .Fa struct pollfd |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
246 to create your own loop. All these functions are usually not required from |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
247 plugins. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
248 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
249 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
250 .Fn irc_bot_prepare |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
251 and |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
252 .Fn irc_bot_flush |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
253 functions first fill the array specified by |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
254 .Fa fds |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
255 and then depending on the user call of |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
256 .Fn poll , |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
257 the |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
258 .Fn irc_bot_flush |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
259 function will dispatch incoming I/O with the result obtained in |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
260 .Fa fds . |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
261 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
262 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
263 .Fn irc_bot_dequeue |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
264 function fills the event |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
265 .Fa ev |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
266 with the first incoming IRC event and returns 1 if any. Otherwise the function |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
267 returns 0 and ev is kept untouched. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
268 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
269 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
270 .Fn irc_bot_post |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
271 append a function to be called within the irccd main thread. It is necessary |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
272 since the whole irccd API isn't thread safe. You only need to post your own |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
273 functions if you want to write threaded plugins. The non-NULL |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
274 .Fa fn |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
275 function will be called with |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
276 .Fa data |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
277 as first argument. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
278 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
279 The |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
280 .Fn irc_bot_finish |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
281 function cleanups any allocated resources. |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
282 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
283 All of the following functions are usually not necessary in any plugin code: |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
284 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
285 .Bl -bullet -compact |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
286 .It |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
287 .Fn irc_bot_dequeue |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
288 .It |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
289 .Fn irc_bot_finish |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
290 .It |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
291 .Fn irc_bot_flush |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
292 .It |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
293 .Fn irc_bot_init |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
294 .It |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
295 .Fn irc_bot_prepare |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
296 .El |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
297 .Pp |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
298 They should be called only if your intent is to write your own bot with the |
3f6d64cdcf0d
man: add libirccd-irccd.3 manual page
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
299 whole irccd API. |
1137 | 300 .\" AUTHORS |
301 .Sh AUTHORS | |
302 The | |
303 .Nm irccd | |
304 daemon was written by | |
305 .An David Demelier Aq Mt markand@malikania.fr . |