Mercurial > irccd
annotate man/irccd.conf.5 @ 1136:f06e9761cc90
misc: update copyright years
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sun, 02 Jan 2022 10:20:57 +0100 |
parents | c46217eaac45 |
children | c165e975f144 |
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:
1095
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.CONF 5 |
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 |
906
b831d9f48b0e
doc: fix various errors
David Demelier <markand@malikania.fr>
parents:
884
diff
changeset
|
21 .Nm irccd.conf |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 .Nd irccd configuration file |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 .\" DESCRIPTION |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 .Sh DESCRIPTION |
996 | 25 The |
26 .Nm | |
27 uses a custom configuration file to setup the IRC daemon. | |
28 .\" SYNTAX | |
29 .Sh SYNTAX | |
30 The file consists of several directives that are evaluated in order of | |
31 appearance. It is advised to follow the same directive order as described in | |
32 this document. | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 .Pp |
996 | 34 The below sections describe the supported syntax. |
35 .\" Comments | |
36 .Ss Comments | |
37 Comments start when a # is found and continue until the next line. | |
38 .\" Strings | |
39 .Ss Strings | |
40 String are either written in pure ASCII strings or enclosed between double | |
41 quotes. Because some reserved tokens may collide with your values, it is | |
42 recommended to use double quoted strings in user values (such as identifiers, | |
43 channels names and such). Also, double quotes are required when string contain | |
44 spaces. | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 .Pp |
996 | 46 Example: |
47 .Bd -literal -offset indent | |
48 String | |
49 "This is a double quoted string" | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
50 .Ed |
996 | 51 .\" Identifiers |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
52 .Ss Identifiers |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 Some sections require an identifier (specified as id) as parameter. They must be |
996 | 54 unique, not empty and can only contain characters, numbers, |
55 .Dq - | |
56 and | |
57 .Dq _ . | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 Example: both |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 .Ar abc |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 and |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 .Ar server-tz2 |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 are valid. |
996 | 64 .\" Blocks |
65 .Ss Blocks | |
1054
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
66 For configuration sections that are more complex, blocks using braces are |
996 | 67 required and each directive between the enclosing block require a trailing |
68 semicolon. | |
69 .Pp | |
70 Example: | |
71 .Bd -literal -offset indent | |
72 block { | |
73 option; | |
74 key and value; | |
75 } | |
76 .Ed | |
77 .\" Lists | |
78 .Ss Lists | |
79 Lists are separated by a comma. | |
80 .Pp | |
81 Example: | |
82 .Bd -literal -offset indent | |
83 one, two, three | |
84 .Ed | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
85 .\" CONFIGURATION SECTIONS |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
86 .Sh CONFIGURATION SECTIONS |
996 | 87 The following sections describe what is allowed in the configuration file. |
88 .\" logs | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
89 .Ss logs |
1054
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
90 This section let you configure how irccd should log the messages. |
996 | 91 .Bl -tag |
1047
d7764d6cdab8
irccd: add support for formatted logs
David Demelier <markand@malikania.fr>
parents:
1025
diff
changeset
|
92 .It Ar logs [verbose|quiet] [template string] to console |
996 | 93 Use the standard output and error to log content. This the default. |
1047
d7764d6cdab8
irccd: add support for formatted logs
David Demelier <markand@malikania.fr>
parents:
1025
diff
changeset
|
94 .It Ar logs [verbose|quiet] [template string] to syslog |
996 | 95 Use the |
96 .Xr syslog 3 | |
97 daemon to log information. | |
1047
d7764d6cdab8
irccd: add support for formatted logs
David Demelier <markand@malikania.fr>
parents:
1025
diff
changeset
|
98 .It Ar logs [verbose|quiet] [template string] to file path |
996 | 99 Use |
100 .Pa path | |
101 to logs every entries. | |
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
102 .El |
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
103 .Pp |
996 | 104 The optional self explained |
105 .Op verbose|quiet | |
106 argument controls either if verbose logging should be enabled or not. Only | |
107 informative messages are affected by this setting. Warnings and debugging | |
108 messages are stored independently from this setting. | |
1047
d7764d6cdab8
irccd: add support for formatted logs
David Demelier <markand@malikania.fr>
parents:
1025
diff
changeset
|
109 .Pp |
d7764d6cdab8
irccd: add support for formatted logs
David Demelier <markand@malikania.fr>
parents:
1025
diff
changeset
|
110 The option |
d7764d6cdab8
irccd: add support for formatted logs
David Demelier <markand@malikania.fr>
parents:
1025
diff
changeset
|
111 .Ar template |
d7764d6cdab8
irccd: add support for formatted logs
David Demelier <markand@malikania.fr>
parents:
1025
diff
changeset
|
112 can be used to format the output log entries using |
d7764d6cdab8
irccd: add support for formatted logs
David Demelier <markand@malikania.fr>
parents:
1025
diff
changeset
|
113 .Ar string |
1054
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
114 as template. This template enable shell attributes, environment variable, date |
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
115 and has the following keywords: |
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
116 .Bl -tag -width unknown |
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
117 .It Va message |
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
118 The message line. |
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
119 .It Va level |
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
120 The level of message (debug, info or warning). |
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
121 .El |
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
122 .Pp |
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
123 See |
1047
d7764d6cdab8
irccd: add support for formatted logs
David Demelier <markand@malikania.fr>
parents:
1025
diff
changeset
|
124 .Xr irccd-templates 7 |
d7764d6cdab8
irccd: add support for formatted logs
David Demelier <markand@malikania.fr>
parents:
1025
diff
changeset
|
125 for more details. |
996 | 126 .\" transport |
127 .Ss transport | |
128 Enable transport to interract with the | |
129 .Nm irccdctl | |
130 utility or any networking program that can communicate through a UNIX domain | |
131 socket. | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
132 .Pp |
1025
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
133 .Ar transport to path [with uid value gid value] |
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
134 .Pp |
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
135 Create the UNIX domain socket on |
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
136 .Pa path . |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
137 .Pp |
1025
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
138 The optional |
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
139 .Ar uid |
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
140 and |
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
141 .Ar gid |
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
142 keywords can take an optional |
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
143 .Ar value |
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
144 to change socket owner and group respectively, it can be a string or a number. |
996 | 145 .\" server |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
146 .Ss server |
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
147 This section is used to connect to one or more server. Create a new server |
996 | 148 section block for each IRC server you want to connect to. |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
149 .Pp |
996 | 150 .Ar server id { options } |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
151 .Pp |
996 | 152 The following directives are allowed in the |
153 .Em options | |
154 block: | |
155 .Bl -tag -width "hostname value" | |
156 .It Ar hostname value | |
157 Connect to the | |
158 .Ar value | |
159 hostname. This can be either a DNS name or a IP address. | |
160 .It Ar port value | |
161 Use | |
162 .Ar value | |
163 number as IP port to connect to. | |
999
c50f954d8c67
irccd: support password
David Demelier <markand@malikania.fr>
parents:
996
diff
changeset
|
164 .It Ar password value |
c50f954d8c67
irccd: support password
David Demelier <markand@malikania.fr>
parents:
996
diff
changeset
|
165 Add the password |
c50f954d8c67
irccd: support password
David Demelier <markand@malikania.fr>
parents:
996
diff
changeset
|
166 .Ar value |
c50f954d8c67
irccd: support password
David Demelier <markand@malikania.fr>
parents:
996
diff
changeset
|
167 if the IRC server requires it. |
996 | 168 .It Ar ident nick user realname |
169 Specify the IRC identity to use by using the three arguments | |
170 .Ar nick , user | |
171 and | |
172 .Ar realname | |
173 as nickname, user name and your real name respectively. | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
174 .Pp |
996 | 175 Note: this is not a list of strings but three arguments separated by a space. If |
176 you want to use a real name with spaces, don't forget the double quotes. | |
177 .It Ar ssl | |
178 Enable SSL. Only available if built with OpenSSL support. | |
179 .It Ar channels list | |
180 List of channels to join automatically when the server is connected | |
181 successfully. This is a list of strings where each element is the channel name | |
182 to join prepended by a optional | |
183 .Ar password@ | |
184 if required. You must use double quotes if the channel starts with a hash (#) | |
185 otherwise it would be detected as a comment. | |
1095
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
186 .It Ar ctcp { key value } |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
187 Specify a CTCP version reply to |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
188 .Ar value |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
189 for the given |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
190 .Ar key |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
191 which may be one of |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
192 .Dq version |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
193 or |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
194 .Dq source . |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
195 The possible |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
196 .Ar key |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
197 are overriding their uppercase CTCP queries. Each entry in this block |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
198 should be terminated by a semicolon. |
996 | 199 .It Ar options list |
200 Use specific server features. This is a list of string which can be one of | |
201 following: | |
202 .Bl -tag -width "AUTO-RECONNECT" | |
203 .It Ar AUTO-RECONNECT | |
204 Reconnect automatically to a server upon disconnection. | |
205 .It Ar AUTO-REJOIN | |
206 Automatically rejoin a channel if the bot was kicked from. | |
207 .It Ar JOIN-INVITE | |
208 Automatically join a channel upon invitation. | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
209 .El |
996 | 210 .It Ar prefix value |
211 Use | |
212 .Ar value | |
213 as command prefix for plugins (Optional, default: | |
214 .Dq \&! ) . | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
215 .El |
996 | 216 .\" rule |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
217 .Ss rule |
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
218 The rule section is one of the most powerful within irccd configuration. It lets |
996 | 219 you enable or disable plugins and IRC events for specific criteria. For |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
220 instance, you may want to disable a plugin only for a specific channel on a |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
221 specific server. And because rules are evaluated in the order they are defined, |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
222 you can override rules. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
223 .Pp |
996 | 224 When you don't specify any value into the corresponding criteria the rule is |
225 considered as matched. | |
226 .Pp | |
227 .Ar rule accept|drop { criteria } | |
228 .Pp | |
229 Create a rule that either | |
230 .Ar accept | |
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
231 or |
996 | 232 .Ar drop |
233 the current event. | |
234 .Pp | |
235 The following directives are allowed in the | |
1008
201ddc487807
irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents:
999
diff
changeset
|
236 .Em criteria |
996 | 237 block: |
238 .Bl -tag -width "channels list" | |
239 .It Ar servers list | |
240 List of servers to match by their ids. | |
241 .It Ar channels list | |
242 List of channel to match. This can be used to match user nicknames as well. | |
243 .It Ar origins list | |
244 List of originators to match. | |
245 .It Ar events list | |
246 List of events to match (in the form onCommand, onMessage, etc). See the | |
247 .Xr irccd 1 | |
248 manual page for the allowed names here. | |
249 .It Ar plugins list | |
250 List of plugins to match by their ids. | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
251 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
252 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
253 Warning: don't make sensitive rules on origins option, irccd does not have any |
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
254 kind of nickname authentication. Thus, it may be very easy for someone |
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
255 to use a temporary nickname. |
996 | 256 .\" hooks |
257 .Ss hooks | |
258 This section loads hooks. The configuration does not test if the file is | |
259 actually executable nor present on the filesystem and will be tried as long as | |
260 the daemon is running. | |
261 .Pp | |
262 .Ar hook id to path | |
263 .Pp | |
264 Load the hook with name | |
265 .Ar id | |
266 from the given | |
267 .Pa path . | |
268 .\" plugins | |
269 .Ss plugins | |
270 This section is used to load plugins. | |
271 .Pp | |
272 To load plugin with default values, you can just use the declaration without | |
273 block of options. Otherwise, use a block to add additional options, | |
274 .Pp | |
275 .Ar plugin id { options } | |
276 .Pp | |
277 The following directives are allowed in the | |
278 .Em options | |
279 block: | |
280 .Bl -tag -width "hostname value" | |
281 .It Ar location path | |
282 Specify an absolute | |
283 .Pa path | |
284 to the plugin. | |
285 .It Ar config { key value } | |
286 Specify a list of options to the plugin as key-value pair. Each entry consist of | |
287 two arguments, the option name and its value both as strings. See | |
288 .Xr EXAMPLES | |
289 for usage. | |
290 .It Ar template { key value } | |
291 Same as | |
292 .Ar config | |
293 but for templates. See | |
294 .Xr irccd-templates 7 | |
295 for more details about this section. | |
296 .It Ar paths { key value } | |
297 Same as | |
298 .Ar config | |
299 but for additional paths. Individual plugins may accept special paths but the | |
300 following are reserved by irccd and always set when loading the plugin unless | |
301 explicitly overriden in this section: | |
302 .Bl -tag | |
303 .It Ar cache | |
304 Directory for temporary files. | |
305 .It Ar data | |
306 Directory for additional data. | |
307 .It Ar config | |
308 Directory to additional configuration files. | |
309 .El | |
310 .El | |
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
311 .\" EXAMPLES |
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
312 .Sh EXAMPLES |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
313 Full example of configuration file |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
314 .Bd -literal |
996 | 315 # Logs to syslog instead of console (which is the default). |
316 logs verbose to syslog | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
317 |
1054
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
318 # Logs using a specific format string (console is recommended for colors). |
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
319 logs verbose template "%H:%M @{orange}#{level}@{} #{message}" |
c1c9a2cd63cb
irccd: add level keyword to log template
David Demelier <markand@malikania.fr>
parents:
1047
diff
changeset
|
320 |
1025
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
321 # Enable transport with default permissions. |
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
322 transport to "/tmp/irccd.sock" |
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
323 |
996 | 324 # |
325 # Create a server "example" that connect to example.org using "fr" as nickname, | |
326 # "francis" as username and "Francis Meyer" as realname. | |
327 # | |
328 # This channel will automatically join "#test" on connection and the password | |
329 # protected "#nightclub" channel with password "secret" | |
330 # | |
1095
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
331 # We also override the CTCP VERSION and SOURCE reply. |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
332 # |
996 | 333 server example { |
334 hostname example.org; | |
335 port 6667; | |
336 ident fr francis "Francis Meyer"; | |
337 channels "#test", "secret@#nightclub"; | |
1095
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
338 ctcp { |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
339 version "custom CTCP VERSION reply"; |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
340 source "custom SCM repository"; |
c46217eaac45
irccd: fix CTCP replies
David Demelier <markand@malikania.fr>
parents:
1054
diff
changeset
|
341 } |
996 | 342 } |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
343 |
996 | 344 # Load several plugins with their default values and locations. |
345 plugin ask | |
346 plugin plugin | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
347 |
996 | 348 # Configure the plugin hangman to change templates and the path to the words. |
349 plugin hangman { | |
350 templates { | |
351 win "Success, the word was #{word}!"; | |
352 } | |
353 config { | |
354 file "/var/irccd/hard-words.txt"; | |
355 } | |
356 } | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
357 |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
358 # This first rule disable the plugin reboot on all servers and channels. |
996 | 359 rule drop { |
360 plugins "reboot"; | |
361 } | |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
362 |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
363 # This rule enable the reboot plugin again on the server localhost, |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
364 # channel #staff. |
996 | 365 rule accept { |
366 servers "localhost"; | |
367 channels "#staff"; | |
368 plugins "reboot"; | |
369 } | |
895
f0d6bc79aa32
irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents:
884
diff
changeset
|
370 |
f0d6bc79aa32
irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents:
884
diff
changeset
|
371 # This create an hook named "mail" with the given path. |
996 | 372 hook mail to "/path/to/mail.py" |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
373 .Ed |
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
374 .\" SEE ALSO |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
375 .Sh SEE ALSO |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
376 .Xr irccd 1 |
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
377 .\" AUTHORS |
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
378 .Sh AUTHORS |
906
b831d9f48b0e
doc: fix various errors
David Demelier <markand@malikania.fr>
parents:
884
diff
changeset
|
379 .Nm irccd |
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
380 was written by David Demelier <markand@malikania.fr> |