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