Mercurial > irccd
annotate man/irccd.conf.5 @ 1029:113e523d999a
man: update some manual pages
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Fri, 26 Feb 2021 16:32:27 +0100 |
| parents | 49a126e8aed0 |
| children | d7764d6cdab8 |
| rev | line source |
|---|---|
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 .\" |
|
1018
cf99df45cb84
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
1008
diff
changeset
|
2 .\" Copyright (c) 2013-2021 David Demelier <markand@malikania.fr> |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 .\" |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 .\" Permission to use, copy, modify, and/or distribute this software for any |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 .\" purpose with or without fee is hereby granted, provided that the above |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 .\" copyright notice and this permission notice appear in all copies. |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 .\" |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 .\" |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 .Dd @IRCCD_MAN_DATE@ |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 .Dt IRCCD.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 | |
| 66 For configuration sections that are more complex, block using braces are | |
| 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 |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
90 This section can let you configure how irccd should log the messages. |
| 996 | 91 .Bl -tag |
| 92 .It Ar logs [verbose|quiet] to console | |
| 93 Use the standard output and error to log content. This the default. | |
| 94 .It Ar logs [verbose|quiet] to syslog | |
| 95 Use the | |
| 96 .Xr syslog 3 | |
| 97 daemon to log information. | |
| 98 .It Ar logs [verbose|quiet] to file path | |
| 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. | |
| 109 .\" transport | |
| 110 .Ss transport | |
| 111 Enable transport to interract with the | |
| 112 .Nm irccdctl | |
| 113 utility or any networking program that can communicate through a UNIX domain | |
| 114 socket. | |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
115 .Pp |
|
1025
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
116 .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
|
117 .Pp |
|
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
118 Create the UNIX domain socket on |
|
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
119 .Pa path . |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
120 .Pp |
|
1025
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
121 The optional |
|
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
122 .Ar uid |
|
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
123 and |
|
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
124 .Ar gid |
|
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
125 keywords can take an optional |
|
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
126 .Ar value |
|
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
127 to change socket owner and group respectively, it can be a string or a number. |
| 996 | 128 .\" server |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
129 .Ss server |
|
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
130 This section is used to connect to one or more server. Create a new server |
| 996 | 131 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
|
132 .Pp |
| 996 | 133 .Ar server id { options } |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
134 .Pp |
| 996 | 135 The following directives are allowed in the |
| 136 .Em options | |
| 137 block: | |
| 138 .Bl -tag -width "hostname value" | |
| 139 .It Ar hostname value | |
| 140 Connect to the | |
| 141 .Ar value | |
| 142 hostname. This can be either a DNS name or a IP address. | |
| 143 .It Ar port value | |
| 144 Use | |
| 145 .Ar value | |
| 146 number as IP port to connect to. | |
|
999
c50f954d8c67
irccd: support password
David Demelier <markand@malikania.fr>
parents:
996
diff
changeset
|
147 .It Ar password value |
|
c50f954d8c67
irccd: support password
David Demelier <markand@malikania.fr>
parents:
996
diff
changeset
|
148 Add the password |
|
c50f954d8c67
irccd: support password
David Demelier <markand@malikania.fr>
parents:
996
diff
changeset
|
149 .Ar value |
|
c50f954d8c67
irccd: support password
David Demelier <markand@malikania.fr>
parents:
996
diff
changeset
|
150 if the IRC server requires it. |
| 996 | 151 .It Ar ident nick user realname |
| 152 Specify the IRC identity to use by using the three arguments | |
| 153 .Ar nick , user | |
| 154 and | |
| 155 .Ar realname | |
| 156 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
|
157 .Pp |
| 996 | 158 Note: this is not a list of strings but three arguments separated by a space. If |
| 159 you want to use a real name with spaces, don't forget the double quotes. | |
| 160 .It Ar ssl | |
| 161 Enable SSL. Only available if built with OpenSSL support. | |
| 162 .It Ar channels list | |
| 163 List of channels to join automatically when the server is connected | |
| 164 successfully. This is a list of strings where each element is the channel name | |
| 165 to join prepended by a optional | |
| 166 .Ar password@ | |
| 167 if required. You must use double quotes if the channel starts with a hash (#) | |
| 168 otherwise it would be detected as a comment. | |
| 169 .It Ar options list | |
| 170 Use specific server features. This is a list of string which can be one of | |
| 171 following: | |
| 172 .Bl -tag -width "AUTO-RECONNECT" | |
| 173 .It Ar AUTO-RECONNECT | |
| 174 Reconnect automatically to a server upon disconnection. | |
| 175 .It Ar AUTO-REJOIN | |
| 176 Automatically rejoin a channel if the bot was kicked from. | |
| 177 .It Ar JOIN-INVITE | |
| 178 Automatically join a channel upon invitation. | |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
179 .El |
| 996 | 180 .It Ar prefix value |
| 181 Use | |
| 182 .Ar value | |
| 183 as command prefix for plugins (Optional, default: | |
| 184 .Dq \&! ) . | |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
185 .El |
| 996 | 186 .\" rule |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
187 .Ss rule |
|
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
188 The rule section is one of the most powerful within irccd configuration. It lets |
| 996 | 189 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
|
190 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
|
191 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
|
192 you can override rules. |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
193 .Pp |
| 996 | 194 When you don't specify any value into the corresponding criteria the rule is |
| 195 considered as matched. | |
| 196 .Pp | |
| 197 .Ar rule accept|drop { criteria } | |
| 198 .Pp | |
| 199 Create a rule that either | |
| 200 .Ar accept | |
|
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
201 or |
| 996 | 202 .Ar drop |
| 203 the current event. | |
| 204 .Pp | |
| 205 The following directives are allowed in the | |
|
1008
201ddc487807
irccd: add irccd.conf file
David Demelier <markand@malikania.fr>
parents:
999
diff
changeset
|
206 .Em criteria |
| 996 | 207 block: |
| 208 .Bl -tag -width "channels list" | |
| 209 .It Ar servers list | |
| 210 List of servers to match by their ids. | |
| 211 .It Ar channels list | |
| 212 List of channel to match. This can be used to match user nicknames as well. | |
| 213 .It Ar origins list | |
| 214 List of originators to match. | |
| 215 .It Ar events list | |
| 216 List of events to match (in the form onCommand, onMessage, etc). See the | |
| 217 .Xr irccd 1 | |
| 218 manual page for the allowed names here. | |
| 219 .It Ar plugins list | |
| 220 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
|
221 .El |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
222 .Pp |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
223 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
|
224 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
|
225 to use a temporary nickname. |
| 996 | 226 .\" hooks |
| 227 .Ss hooks | |
| 228 This section loads hooks. The configuration does not test if the file is | |
| 229 actually executable nor present on the filesystem and will be tried as long as | |
| 230 the daemon is running. | |
| 231 .Pp | |
| 232 .Ar hook id to path | |
| 233 .Pp | |
| 234 Load the hook with name | |
| 235 .Ar id | |
| 236 from the given | |
| 237 .Pa path . | |
| 238 .\" plugins | |
| 239 .Ss plugins | |
| 240 This section is used to load plugins. | |
| 241 .Pp | |
| 242 To load plugin with default values, you can just use the declaration without | |
| 243 block of options. Otherwise, use a block to add additional options, | |
| 244 .Pp | |
| 245 .Ar plugin id { options } | |
| 246 .Pp | |
| 247 The following directives are allowed in the | |
| 248 .Em options | |
| 249 block: | |
| 250 .Bl -tag -width "hostname value" | |
| 251 .It Ar location path | |
| 252 Specify an absolute | |
| 253 .Pa path | |
| 254 to the plugin. | |
| 255 .It Ar config { key value } | |
| 256 Specify a list of options to the plugin as key-value pair. Each entry consist of | |
| 257 two arguments, the option name and its value both as strings. See | |
| 258 .Xr EXAMPLES | |
| 259 for usage. | |
| 260 .It Ar template { key value } | |
| 261 Same as | |
| 262 .Ar config | |
| 263 but for templates. See | |
| 264 .Xr irccd-templates 7 | |
| 265 for more details about this section. | |
| 266 .It Ar paths { key value } | |
| 267 Same as | |
| 268 .Ar config | |
| 269 but for additional paths. Individual plugins may accept special paths but the | |
| 270 following are reserved by irccd and always set when loading the plugin unless | |
| 271 explicitly overriden in this section: | |
| 272 .Bl -tag | |
| 273 .It Ar cache | |
| 274 Directory for temporary files. | |
| 275 .It Ar data | |
| 276 Directory for additional data. | |
| 277 .It Ar config | |
| 278 Directory to additional configuration files. | |
| 279 .El | |
| 280 .El | |
|
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
281 .\" EXAMPLES |
|
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
282 .Sh EXAMPLES |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
283 Full example of configuration file |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
284 .Bd -literal |
| 996 | 285 # Logs to syslog instead of console (which is the default). |
| 286 logs verbose to syslog | |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
287 |
|
1025
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
288 # Enable transport with default permissions. |
|
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
289 transport to "/tmp/irccd.sock" |
|
49a126e8aed0
irccd: transport can now set an uid/gid
David Demelier <markand@malikania.fr>
parents:
1018
diff
changeset
|
290 |
| 996 | 291 # |
| 292 # Create a server "example" that connect to example.org using "fr" as nickname, | |
| 293 # "francis" as username and "Francis Meyer" as realname. | |
| 294 # | |
| 295 # This channel will automatically join "#test" on connection and the password | |
| 296 # protected "#nightclub" channel with password "secret" | |
| 297 # | |
| 298 server example { | |
| 299 hostname example.org; | |
| 300 port 6667; | |
| 301 ident fr francis "Francis Meyer"; | |
| 302 channels "#test", "secret@#nightclub"; | |
| 303 } | |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
304 |
| 996 | 305 # Load several plugins with their default values and locations. |
| 306 plugin ask | |
| 307 plugin plugin | |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
308 |
| 996 | 309 # Configure the plugin hangman to change templates and the path to the words. |
| 310 plugin hangman { | |
| 311 templates { | |
| 312 win "Success, the word was #{word}!"; | |
| 313 } | |
| 314 config { | |
| 315 file "/var/irccd/hard-words.txt"; | |
| 316 } | |
| 317 } | |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
318 |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
319 # This first rule disable the plugin reboot on all servers and channels. |
| 996 | 320 rule drop { |
| 321 plugins "reboot"; | |
| 322 } | |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
323 |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
324 # 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
|
325 # channel #staff. |
| 996 | 326 rule accept { |
| 327 servers "localhost"; | |
| 328 channels "#staff"; | |
| 329 plugins "reboot"; | |
| 330 } | |
|
895
f0d6bc79aa32
irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents:
884
diff
changeset
|
331 |
|
f0d6bc79aa32
irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents:
884
diff
changeset
|
332 # This create an hook named "mail" with the given path. |
| 996 | 333 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
|
334 .Ed |
|
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
335 .\" SEE ALSO |
|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
336 .Sh SEE ALSO |
|
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
337 .Xr irccd 1 |
|
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
338 .\" AUTHORS |
|
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
339 .Sh AUTHORS |
|
906
b831d9f48b0e
doc: fix various errors
David Demelier <markand@malikania.fr>
parents:
884
diff
changeset
|
340 .Nm irccd |
|
856
6c4fb8f42aca
doc: improve wording and style
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
341 was written by David Demelier <markand@malikania.fr> |