Mercurial > irccd
annotate doc/man/irccd.conf.5.in @ 394:c6fbb6e0e06d
Happy new year!
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Sun, 01 Jan 2017 15:29:41 +0100 |
| parents | 2a9805acb178 |
| children | 31837008f7e2 |
| rev | line source |
|---|---|
| 0 | 1 .\" |
| 394 | 2 .\" Copyright (c) 2013-2017 David Demelier <markand@malikania.fr> |
| 0 | 3 .\" |
| 4 .\" Permission to use, copy, modify, and/or distribute this software for any | |
| 5 .\" purpose with or without fee is hereby granted, provided that the above | |
| 6 .\" copyright notice and this permission notice appear in all copies. | |
| 7 .\" | |
| 8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
| 9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
| 10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
| 11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
| 12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
| 13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
| 14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
| 15 .\" | |
| 16 .Dd @MONTH@ @DAY@, @YEAR@ | |
| 17 .Dt IRCCD.CONF 5 | |
| 18 .Os | |
| 19 .Sh NAME | |
| 20 .Nm irccd.conf | |
| 21 .Nd irccd configuration file | |
| 22 .Sh DESCRIPTION | |
| 23 The file | |
| 24 .Nm irccd.conf | |
| 25 contains all parameters for the application | |
| 26 .Nm irccd . | |
| 27 .Pp | |
| 28 The irccd.conf file is .ini based syntax, with some extensions. | |
| 29 .\" SYNTAX | |
| 30 .Sh SYNTAX | |
| 31 The usual syntax is: | |
| 32 .Bd -literal -offset indent | |
| 33 [foo] | |
| 34 option = value | |
| 35 | |
| 36 [bar] | |
| 37 name = "long string enclosed between quotes" | |
| 38 | |
| 39 [lists] | |
| 40 servers = ( "server1", "server2" ) | |
| 41 .Pp | |
| 42 .Ed | |
| 43 Comments start with # and continue to the end of the line. | |
| 44 .Pp | |
| 45 Note that quotes are needed if the value has more that one word, if not the | |
| 46 value will be truncated at the first space found. | |
| 47 .\" CONFIGURATION | |
| 48 .Sh CONFIGURATION | |
| 49 This section shows all available sections with the options allowed for them. | |
| 50 .\" GENERAL | |
| 51 .Ss general | |
| 52 This section covers general options. | |
| 53 .Pp | |
| 54 .Bl -tag -width XXXXXXXXXXXXXXXXXXX -compact | |
| 55 .It uid | |
| 56 (string or number) the user id to use (Optional, default: none), | |
| 57 .It gid | |
| 58 (string or number) the group id to use (Optional, default: none), | |
| 59 .It foreground | |
| 60 (bool) set to true to not daemonize (Optional, default: false) | |
| 61 .It pidfile | |
| 62 (string) path to a file where to store the irccd pid (Optional, default: none). | |
| 63 .El | |
| 64 .\" LOGS | |
| 65 .Ss logs | |
| 66 This section can let you configure how irccd should log the messages. | |
| 67 .Pp | |
| 68 .Bl -tag -width XXXXXXXXXXXXXXXXXXX -compact | |
| 69 .It verbose | |
| 70 (bool) be verbose (Optional, default: false), | |
| 71 .It type | |
| 72 (string) which kind of logging, console, file or syslog (Optional, default: console). | |
| 73 .El | |
| 74 .Pp | |
| 75 The following parameters are available for type "file": | |
| 76 .Pp | |
| 77 .Bl -tag -width PARAMETERXXX -compact -offset indent | |
| 78 .It path-logs | |
| 79 (string) path to the normal messages, | |
| 80 .It path-errors | |
| 81 (string) path to the error messages. | |
| 82 .El | |
|
120
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
83 .\" FORMAT |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
84 .Ss format |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
85 The format section let you change the irccd's output. It uses the common patterns. |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
86 .Pp |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
87 Only one keyword is defined, message which contains the message that irccd wants to output. |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
88 .Pp |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
89 Note: the colors and attributes are not supported. |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
90 .Pp |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
91 .Bl -tag -width XXXXXXXXXXXXXXXXXXX -compact |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
92 .It debug |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
93 (string) template to use to format debug messages (Optional, default: none), |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
94 .It info |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
95 (string) template to use to format information messages (Optional, default: none), |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
96 .It warning |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
97 (string) template to use to format warnings (Optional, default: none). |
|
4cb417fd4e18
Irccd: add brand new format section, #410
David Demelier <markand@malikania.fr>
parents:
102
diff
changeset
|
98 .El |
| 0 | 99 .\" IDENTITY |
| 100 .Ss identity | |
| 101 This section is completely optional, if you don't provide one, irccd will use | |
| 102 a default identity with irccd as nickname and username. This section is | |
| 103 redefinable, you can create one or more. | |
| 104 .Pp | |
| 105 .Bl -tag -width XXXXXXXXXXXXXXXXXXX -compact | |
| 106 .It name | |
| 107 (id) the identity unique id. | |
| 108 .It nickname | |
| 109 (string) the nickname (Optional, default: irccd). | |
| 110 .It realname | |
| 111 (string) the realname (Optional, default: IRC Client daemon). | |
| 112 .It username | |
| 113 (string) the username name (Optional, default: irccd). | |
| 114 .It ctcp-version | |
| 115 (string) what version to respond to CTCP VERSION (Optional, default: IRC Client Daemon). | |
| 116 .It ctcp-autoreply | |
| 117 (bool) enable auto CTCP VERSION reply, (Optional, default: true). | |
| 118 .El | |
| 119 .\" SERVER | |
| 120 .Ss server | |
| 121 This section is used to connect to one or more server. Thus, this section is also redefinable. | |
| 122 .Pp | |
| 123 .Bl -tag -width XXXXXXXXXXXXXXXXXXX -compact | |
| 124 .It name | |
| 125 (id) the unique id. | |
| 126 .It host | |
| 127 (string) the server address. | |
| 128 .It port | |
| 129 (int) the server port. | |
| 130 .It identity | |
| 131 (string) an identity to use (Optional, default: irccd's default). | |
| 132 .It password | |
| 133 (string) an optional password (Optional, default: none). | |
| 134 .It auto-rejoin | |
| 135 (bool) auto rejoin a channel after being kicked (Optional, default: false), | |
| 136 .It join-invite | |
| 137 (bool) join channels upon invitation (Optional, default: false). | |
| 138 .It channels | |
| 139 (list) list of channels to auto join, (Optional, default: empty). | |
| 140 .It command-char | |
| 141 (string) the prefix for invoking special commands (Optional, default: !). | |
| 142 .It ssl | |
| 143 (bool) enable or disable SSL (Optional, default: false). | |
| 144 .It ssl-verify | |
| 145 (bool) verify the SSL certificates (Optional, default: true). | |
| 146 .It reconnect | |
| 147 (bool) enable reconnection after failure (Optional, default: true). | |
| 148 .It reconnect-tries | |
|
22
23d59afec277
Irccd: fix server.reconnect-tries, #417
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
149 (int) number of tries before giving up. A value of -1 means indefinitely (Optional, default: -1). |
| 0 | 150 .It reconnect-timeout |
| 151 (int) number of seconds to wait before retrying (Optional, default: 30). | |
|
102
4777f7e18bf2
Irccd: several improvements in servers, #385
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
152 .It ping-timeout |
|
4777f7e18bf2
Irccd: several improvements in servers, #385
David Demelier <markand@malikania.fr>
parents:
51
diff
changeset
|
153 (int) number of seconds before ping timeout (Optional, default: 300). |
| 0 | 154 .El |
| 155 .\" PLUGINS | |
| 156 .Ss plugins | |
| 157 This section is used to load plugins. | |
| 158 .Pp | |
| 159 Just add any key you like to load a plugin. If the value is not specified, the plugin is searched through the standard | |
| 160 directories, otherwise, provide the full path (including the .js extension). | |
| 161 .Pp | |
| 162 Example | |
| 163 .Bd -literal | |
| 164 [plugins] | |
| 165 hangman = "" | |
| 166 .Ed | |
| 167 .\" TRANSPORT | |
| 168 .Ss transport | |
| 169 This section defines transports, you may use sockets to do a basic IPC system within irccd. | |
| 170 .Pp | |
| 171 With transports, you can may ask `irccd` to send a message, a notice or even kicking someone from a channel. Irccd | |
| 172 will also notify all clients connected to this transport on IRC events. | |
| 173 .Pp | |
| 174 There are two type of listeners availables: | |
| 175 .Bl -enum -offset 2n | |
| 176 .It | |
| 177 Internet sockets, IPv4 and IPv6 | |
| 178 .It | |
| 179 Unix sockets, based on files (not available on Windows) | |
| 180 .El | |
| 181 .Pp | |
| 182 .Bl -tag -width XXXXXXXXXXXXXXXXXXX -compact | |
|
373
2a9805acb178
Docs: fix some issues in irccd.conf(5)
David Demelier <markand@malikania.fr>
parents:
120
diff
changeset
|
183 .It type |
| 0 | 184 (string) type of listener "ip" or "unix" |
| 185 .El | |
| 186 .Pp | |
| 187 The following parameters are available for type "ip": | |
| 188 .Pp | |
| 189 .Bl -tag -width PARAMETERXXX -compact -offset indent | |
| 190 .It port | |
| 191 (int) port number. | |
| 192 .It address | |
| 193 (string) address to bind or "*" for any (Optional, default: *). | |
| 194 .It familty | |
| 195 (list) ipv6, ipv4. Both are accepted (Optional, default: ipv4) | |
| 196 .El | |
| 197 .Pp | |
| 198 The following parameters are available for type "unix": | |
| 199 .Pp | |
| 200 .Bl -tag -width PARAMETERXXX -compact -offset indent | |
| 201 .It path | |
| 202 (string) the file path to the socket. | |
| 203 .El | |
| 204 .\" RULE | |
| 205 .Ss rule | |
| 206 The rule section is one of the most powerful within irccd configuration. | |
| 207 .Pp | |
| 208 It let you enable or disable plugins and IRC events for specific criterias. For | |
| 209 instance, you may want to disable a plugin only for a specific channel on a | |
| 210 specific server. And because rules are evaluated in the order they are defined, | |
| 211 you can override rules. | |
| 212 .Pp | |
| 213 .Bl -tag -width XXXXXXXXXXXXXXXXXXX -compact | |
| 214 .It servers | |
| 215 (list) a list of servers that will match the rule (Optional, default: empty), | |
| 216 .It channels | |
| 217 (list) a list of channel (Optional, default: empty), | |
| 218 .It plugins | |
| 219 (list) which plugins (Optional, default: empty), | |
| 220 .It events | |
| 221 (list) which events (e.g onCommand, onMessage, ...) (Optional, default: empty), | |
| 222 .It action | |
| 223 (string) set to **accept** or **drop**. | |
|
373
2a9805acb178
Docs: fix some issues in irccd.conf(5)
David Demelier <markand@malikania.fr>
parents:
120
diff
changeset
|
224 .El |
| 0 | 225 .\" FILES |
| 226 .Sh FILES | |
| 227 The default config file is located at | |
|
51
2a6ac6daceee
Docs: fix various typos in manuals
David Demelier <markand@malikania.fr>
parents:
22
diff
changeset
|
228 .Em @CMAKE_INSTALL_PREFIX@/@WITH_CONFDIR@/irccd.conf |
| 0 | 229 .Pp |
| 230 The user defined file follow the XDG standard and is usually | |
| 231 .Em $HOME/.config/irccd/irccd.conf . | |
| 232 If the XDG variable is not set, we use that path. | |
| 233 .\" SEE ALSO | |
| 234 .Sh SEE ALSO | |
| 235 .Xr irccd 1 | |
| 236 .\" AUTHORS | |
| 237 .Sh AUTHORS | |
| 238 irccd was written by David Demelier <markand@malikania.fr> |