Mercurial > irccd

annotate man/irccd.1 @ 1181:309dab921cfb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: merge from stable-4
author David Demelier <markand@malikania.fr>
date Wed, 18 Jan 2023 20:35:35 +0100
parents c165e975f144
children 1845a0509a93
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .\"
1136
f06e9761cc90 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 1126
diff changeset
2 .\" Copyright (c) 2013-2022 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 1
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
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Nd IRC Client Daemon
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .\" SYNOPSIS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Sh SYNOPSIS
864
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
25 .Nm
1087
eee4d67d78a8 irccd: resurrect -v option
David Demelier <markand@malikania.fr>
parents: 1062
diff changeset
26 .Op Fl v
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 .Op Fl c Ar file
864
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
28 .Nm
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
29 .Ar info
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
30 .Nm
1118
fc89091b8345 irccd: add paths subcommand
David Demelier <markand@malikania.fr>
parents: 1087
diff changeset
31 .Ar paths
fc89091b8345 irccd: add paths subcommand
David Demelier <markand@malikania.fr>
parents: 1087
diff changeset
32 .Nm
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 .Ar version
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 .\" DESCRIPTION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 .Sh DESCRIPTION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 The
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 program is an IRC bot which connects to one or more severs and
864
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
39 dispatches events to plugins and connected clients.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 The following options are available:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 .Bl -tag -width indent-xxx
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 .It Fl c Ar file
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 specify the configuration file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 .It Fl v
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 be verbose.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 .El
864
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
48 .Pp
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
49 When ran without arguments,
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
50 .Nm
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
51 will read your configuration file and dispatch IRC events to the plugins and
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
52 connected clients indefinitely.
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
53 .Pp
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
54 Otherwise, the following commands are available:
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
55 .Bl -tag -width 12n
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
56 .It Cm info
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
57 Show in a scriptable manner the options that were selected during irccd's build.
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
58 .It Cm version
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
59 Get the irccd version. if Mercurial was available when building irccd then the
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
60 current revision is bundled in the output.
1118
fc89091b8345 irccd: add paths subcommand
David Demelier <markand@malikania.fr>
parents: 1087
diff changeset
61 .It Cm paths
fc89091b8345 irccd: add paths subcommand
David Demelier <markand@malikania.fr>
parents: 1087
diff changeset
62 Shows where irccd will load plugins, configuration files and such.
864
0028704ab284 doc: improve irccd.1 wording
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
63 .El
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 .\" PLUGINS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 .Sh PLUGINS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 The
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 .Nm
895
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
68 program can run plugins once IRC events are received. For example, if someone
1055
1965c1c23454 man: improve wording
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
69 sends you a private message plugins will be invoked with that event. Both
1965c1c23454 man: improve wording
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
70 native plugins written in C or C++ and Javascript are supported (if enabled at
1965c1c23454 man: improve wording
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
71 compile time).
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 The following IRC events are supported:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 .Bl -tag -width 12n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 .\" onCommand
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 .It onCommand
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 This is a special event that does not exist in IRC context. It calls the plugin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 special invocation command using
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 .Ar "!name arguments..."
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 syntax. The exclamation mark is configured by default to be the command
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 character prefix, then if the adjacent name is known to be a loaded plugin it is
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 invoked with the additional arguments.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 Example: to call the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 .Nm hangman
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 plugin, one may use !hangman to start a game.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 See also
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 .Xr irccd.conf 5
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 on how to change the command character prefix under a
1055
1965c1c23454 man: improve wording
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
91 .Va server
1965c1c23454 man: improve wording
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
92 section block.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 .\" onConnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 .It onConnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
95 When a server successfully connects to an IRC server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 .\" onDisconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 .It onDisconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
98 When a server disconnected from an IRC server both in case of failures or
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 explicit user disconnection.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 .\" onInvite
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 .It onInvite
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
102 Event called when the bot itself has been invited to a channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
103 .\" onJoin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 .It onJoin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
105 When someone joins a channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 .\" onKick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
107 .It onKick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 When someone has been kicked from a channel, irccd may be included.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 .\" onLoad
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
110 .It onLoad
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
111 This is a special event that does not exist in IRC context. It is invoked when
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
112 the plugin is initialized.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
113 .\" onMessage
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
114 .It onMessage
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
115 Upon private message.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
116 .\" onMe
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 .It onMe
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
118 On action emote, also most known as
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 .Ar /me
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 command.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
121 .\" onMode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
122 .It onMode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
123 When a user or channel mode change.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
124 .\" onNames
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
125 .It onNames
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
126 When a list of nicknames has been received.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
127 .\" onNick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
128 .It onNick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
129 On nick change, irccd may be included.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
130 .\" onNotice
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
131 .It onNotice
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
132 On private notice.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
133 .\" onPart
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
134 .It onPart
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
135 When someone leaves a channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
136 .\" onReload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
137 .It onReload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
138 This is a special event that does not exist in IRC context. It is invoked when
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
139 the user asks to reload a plugin.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
140 .\" onTopic
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
141 .It onTopic
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
142 When a channel topic has been changed.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
143 .\" onUnload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
144 .It onUnload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
145 This is a special event that does not exist in IRC context. It is invoked when
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
146 the user asks to unload a plugin and before exiting.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
147 .\" onWhois
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
148 .It onWhois
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
149 When a whois information has been received.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
150 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
151 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
152 The following plugins are provided with irccd:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
153 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
154 .Bl -bullet -compact
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
155 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
156 ask
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
157 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
158 auth
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
159 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
160 hangman
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
161 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
162 history
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
163 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
164 joke
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
165 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
166 links
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
167 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
168 logger
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
169 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
170 plugin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
171 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
172 roulette
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
173 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
174 tictactoe
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
175 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
176 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
177 See additional documentation in their own manual page in the form
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
178 .Xr irccd-plugin-name 7
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
179 where name is the actual plugin name.
895
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
180 .\" HOOKS
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
181 .Sh HOOKS
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
182 Hooks are a different and more lightweight approach to plugins, they are
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
183 executed upon incoming events and spawned each time a new event arrives.
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
184 .Pp
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
185 In contrast to plugins, differences are:
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
186 .Pp
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
187 .Bl -bullet -compact
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
188 .It
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
189 Hooks can not be filtered with rules.
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
190 .It
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
191 Hooks does not support all events. These events are not supported:
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
192 .Em onLoad , onUnload , onReload , onCommand , onNames , onWhois .
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
193 .It
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
194 Hooks can be written in any language.
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
195 .It
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
196 Execution may be slower since scripting languages require to fire up the
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
197 interpreter each time a new event is available.
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
198 .El
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
199 .Pp
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
200 Each hook will receive as positional argument the event name (similar to plugin
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
201 events) and the event arguments.
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
202 .Pp
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
203 See also the section
1055
1965c1c23454 man: improve wording
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
204 .Va hooks
895
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
205 in
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
206 .Xr irccd.conf 5
f0d6bc79aa32 irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents: 864
diff changeset
207 manual page to enable hooks.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
208 .\" TRANSPORTS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
209 .Sh TRANSPORTS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
210 The daemon can be controlled at runtime using the dedicated
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
211 .Nm irccdctl
1055
1965c1c23454 man: improve wording
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
212 tool or using raw TCP messages on a UNIX domain socket file.
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
213 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
214 See also the
1055
1965c1c23454 man: improve wording
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
215 .Va transport
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
216 section in the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
217 .Xr irccd.conf 5
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
218 manual page.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
219 .\" RULES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
220 .Sh RULES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
221 .Nm
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
222 supports a feature called rules which allows you to define a fine-grained set of
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
223 rules allowed for specific plugins. For instance, you may want to disable some
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
224 IRC events for some plugins depending on your set of parameters. This is useful
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
225 for plugins that generates huge traffic.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
226 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
227 Rule events are matched using the same name as plugin events described in the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
228 section above. For example, to disable a private message event you must use the
1062
7bc2e8fac3dc man: fix typo
David Demelier <markand@malikania.fr>
parents: 1055
diff changeset
229 .Ar onMessage
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
230 value.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
231 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
232 See also the
1055
1965c1c23454 man: improve wording
David Demelier <markand@malikania.fr>
parents: 1018
diff changeset
233 .Va rule
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
234 section in the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
235 .Xr irccd.conf 5
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
236 manual page.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
237 .\" SEE ALSO
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
238 .Sh SEE ALSO
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
239 .Xr irccd-api 7 ,
1126
722fcb2930ea man: add irccd-cmake(7) manual page
David Demelier <markand@malikania.fr>
parents: 1118
diff changeset
240 .Xr irccd-cmake 7 ,
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
241 .Xr irccd-ipc 7 ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
242 .Xr irccd-plugin-ask 7 ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
243 .Xr irccd-plugin-auth 7 ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
244 .Xr irccd-plugin-hangman 7 ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
245 .Xr irccd-plugin-history 7 ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
246 .Xr irccd-plugin-joke 7 ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
247 .Xr irccd-plugin-links 7 ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
248 .Xr irccd-plugin-logger 7 ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
249 .Xr irccd-plugin-plugin 7 ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
250 .Xr irccd-plugin-roulette 7 ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
251 .Xr irccd-plugin-tictactoe 7 ,
1126
722fcb2930ea man: add irccd-cmake(7) manual page
David Demelier <markand@malikania.fr>
parents: 1118
diff changeset
252 .Xr irccd-templates 7 ,
845
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
253 .Xr irccd.conf 5 ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
254 .Xr irccdctl 1 ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff changeset
255 .Xr irccdctl.conf 5
1137
c165e975f144 man: improvements
David Demelier <markand@malikania.fr>
parents: 1136
diff changeset
256 .\" AUTHORS
c165e975f144 man: improvements
David Demelier <markand@malikania.fr>
parents: 1136
diff changeset
257 .Sh AUTHORS
c165e975f144 man: improvements
David Demelier <markand@malikania.fr>
parents: 1136
diff changeset
258 The
c165e975f144 man: improvements
David Demelier <markand@malikania.fr>
parents: 1136
diff changeset
259 .Nm
c165e975f144 man: improvements
David Demelier <markand@malikania.fr>
parents: 1136
diff changeset
260 daemon was written by
c165e975f144 man: improvements
David Demelier <markand@malikania.fr>
parents: 1136
diff changeset
261 .An David Demelier Aq Mt markand@malikania.fr .
c165e975f144 man: improvements
David Demelier <markand@malikania.fr>
parents: 1136
diff changeset
262 .\" AUTHORS
c165e975f144 man: improvements
David Demelier <markand@malikania.fr>
parents: 1136
diff changeset
263 .Sh AUTHORS
c165e975f144 man: improvements
David Demelier <markand@malikania.fr>
parents: 1136
diff changeset
264 The
c165e975f144 man: improvements
David Demelier <markand@malikania.fr>
parents: 1136
diff changeset
265 .Nm irccd
c165e975f144 man: improvements
David Demelier <markand@malikania.fr>
parents: 1136
diff changeset
266 daemon was written by
c165e975f144 man: improvements
David Demelier <markand@malikania.fr>
parents: 1136
diff changeset
267 .An David Demelier Aq Mt markand@malikania.fr .