huge propset, fixes eol-style on everything and sets keywords and copyright on all...
[openwrt/svn-archive/archive.git] / net / miau / files / miaurc
1 #
2 # miau 0.5.3 configuration file example
3 # (C) 2003-2004 Tommi Saviranta <tsaviran@cs.helsinki.fi>
4 #
5
6 # About structure of this configuration file:
7 #
8 # - All parameters are written inside quotes (for example, "foobar")
9 #
10 # - Options are defined like: option = "parameter1"[:"parameter2"] ...
11 #
12 # - When entering multiparameter options, certain parameters have default
13 # values and can be left out.
14 #
15 # - When entering multiparameter options and, for example, user doesn't want
16 # to set parameter2 at all but he needs to set parameter3, parameter2 can
17 # be skipped with column (':') like: "parameter1"::"parameter3".
18 #
19 # - Empty lines and characters after '#' (hash) are ignored.
20 #
21 # - When setting permissions, switched etc. (switches (booleans) are described
22 # as "state"), everything beginning with "t", "r" and "1" are concidered as
23 # "true" or "yes" (positive). Everything else is "false" or "no" (negative).
24
25
26
27 # Required settings
28 ################################################################################
29
30
31 # nicknames = { "nick" }: Your nickname (and secondary nicknames) on IRC.
32 # If the primary nick (first nick on the list) is already on use,
33 # miau will try the others on the list.
34 #
35 # Default: no default
36 #
37 # Example:
38 #nicknames = {
39 # "zak"
40 # "zakh"
41 #}
42
43
44 # realname = "realname": Your "real" name on IRC.
45 #
46 # Default: no default
47 #
48 # Example:
49 #realname = "Prokhor Zakharov"
50
51
52 # username = "username": Your ident (matters only if you don't have identd
53 # running).
54 #
55 # Default: no default
56 #
57 # Example:
58 #username = "zak"
59
60
61 # password = "password": The password miau will expect to receive from client
62 # when it's registering with nick. If this is 13 characters long,
63 # miau assumed it's crypted.
64 #
65 # If miau is compiled with ENABLE_MKPASSWD, miau can generate password-hashes
66 # (from command line) with -c -switch.
67 #
68 # Default: no default
69 #
70 # Example:
71 #password = "foobar"
72
73
74 # listenport = "port": The port miau will wait for incoming connections.
75 #
76 # Default: no default
77 #
78 # Example:
79 #listenport = "4096"
80
81
82 # servers = { "server":"port":"password":"timeout" }: miau's IRC-server-list.
83 # Each line represents one server, where timeout is delay in
84 # seconds before connectiong attempt times out. Only "server"
85 # parameter is required.
86 #
87 # Default: no default
88 #
89 # Example:
90 #servers = {
91 # "irc.net"
92 # "irc.foo.bar":"6662"
93 # "localhost"::"foobar"
94 # "127.0.0.1":"6670"::"5"
95 #}
96
97
98 # connhosts = { "host":"permitted" }: List of hosts that are allowed (or denied)
99 # to connect to miau. When boolean-value is left unset, it is
100 # assumed to be "true". This list will be processed as a chain
101 # which means latter rules can override previous ones.
102 #
103 # Default: no default
104 #
105 # Example:
106 #connhosts = {
107 # "*":"yes"
108 # "client*.evil.net":"no"
109 #}
110
111
112
113 # Optional settings
114 ################################################################################
115
116
117 # listenhost = "host": Host miau uses to listen on.
118 #
119 # If you are compiled with IPV6 and need this to listen on an IPV4 port, you
120 # must use an IP in the form ::FFFF:127.0.0.1
121 #
122 # Default: no default
123 #
124 # Example:
125 #listenhost = "127.0.0.1"
126
127
128 # bind = "host": Host/IP miau uses for outgoing connections.
129 #
130 # Default: none
131 #
132 # Example:
133 #bind = "172.16.1.1"
134
135
136 # maxclients = "number": Maximum number of clients connected to miau
137 # concurrently. Set to zero for unlimited clients.
138 #
139 # Default: 3
140 #
141 #Example:
142 #maxclients = "1"
143
144
145 # stonedtimeout = "seconds": Time (in seconds) with no data from the server
146 # before it is declared stoned and being disconnected. Although
147 # minimum value is 30, this value has no upper limit. Watch out,
148 # though, if this value is set too high, death of servers may stay
149 # undetected for a very long time if you are idle.
150 #
151 # Default: 90
152 #
153 # Example:
154 #stonedtimeout = "150"
155
156
157 # connecttimeout = "seconds": Time (in seconds) before connection attampt will
158 # time out. Note that while connecting to the server miau will not
159 # respond to clients. Minimum value is 5, and many systems define
160 # maximum value.
161 #
162 # Default: 30
163 #
164 # Example:
165 #connecttimeout = "60"
166
167
168 # channels = { "channel":"keyword" }: List of channels to join.
169 #
170 # Default: none
171 #
172 # Example:
173 #channels = {
174 # "#foobar"
175 # "#miau":"cats"
176 #}
177
178
179 # rejoin = "state": Rejoin channels after disconnecting from the server.
180 # If rejoin is set to true, channels defined in "channels" are
181 # also joined when client first time connects to miau.
182 #
183 # Default: true
184 #
185 # Example:
186 #rejoin = "false"
187
188
189 # leave = "state": Leave channels when all clients have detached from miau.
190 # If "leave" is set to "false" and "rejoin" is set to "true",
191 # channels defined at "channels" will be joined at miau startup.
192 # If both "leave" and "rejoin" is set to "true", channels that
193 # are left at client detach, are rejoined when client attached
194 # back to miau.
195 #
196 # Default: false
197 #
198 # Example:
199 #leave = "false"
200
201
202 # leavemsg = "message": Message miau will either use as PART-message or as an
203 # ACTION when all clients have detached from miau. If unset or
204 # set to empty, no message will be shown. Note that many people
205 # dislike event-based messages (which happens when "leave" is set
206 # to "false" and "leavemsg" is set). Also see usequitmsg.
207 #
208 # Note: Note that commenting this option out and rehashing after leavemsg was
209 # set, this option is _not_ reverted. To disable leavemsg afterwards you
210 # need to write an empty string here and rehash.
211 #
212 # Default: none
213 #
214 # Example:
215 #leavemsg = "doh"
216
217
218 # awaymsg = "message": Text that will be set to miau's away-reason when all
219 # clients have detached from miau. If unset or set to empty,
220 # AWAY-status will be left untouched. When any client attaches
221 # back to miau, AWAY-status will be reset. Also see usequitmsg.
222 #
223 # Note: If user sets him/herself away, miau will not touch away-status nor
224 # message neither when connecting to or disconnecting from miau.
225 #
226 # Note: Note that commenting this option out and rehashing after awaymsg was
227 # set, this option is _not_ reverted. To disable awaymsg afterwards you
228 # need to write an empty string here and rehash.
229 #
230 # Default: none
231 #
232 # Example:
233 #awaymsg = "bouncing around - all private messages will be logged"
234
235
236 # usequitmsg = "state": Use last quit-reason as away-reason and/or leave-message
237 # (if respective options are enabled) when all clients have
238 # disconnected from miau. If quit-reason is empty, default values
239 # of awaymsg and leavemsg will be used, otherwise most recent
240 # quit-message overrides values in miaurc.
241 #
242 # Default: true
243 #
244 # Example:
245 # usequitmsg = "false"
246
247
248 # getnick = "selection": miau can try to reclaim your primary nick when it is
249 # lost. This option may be one of the following: "never",
250 # "detached", "attached", or "always".
251 # "never" ....... miau will not try to get your nick back.
252 # "detached" .... miau will try to get your nick when no
253 # clients are attached.
254 # "attached" .... miau will try to get your nick when
255 # there are one or more clients attached.
256 # "always" ...... miau will try to get your nick
257 #
258 # Note: Do _not_ use options "attached" and "always" with clients (like
259 # irc-II EPIC) that automatically change your nick when they receive
260 # NICKINUSE from the server - you might end up chaning your nick until
261 # server drops your connection due excess flood.
262 #
263 # Default: detached
264 #
265 # Example:
266 #getnick = "always"
267
268
269 # getnickinterval = "seconds": Time between tries (in seconds) to obtain
270 # currently (possibly) lost primary nick. Don't set it too low
271 # or you might get kicked out the server due to excess flood.
272 #
273 # Default: 60
274 #
275 # Example:
276 #getnickinterval = "30"
277
278
279 # antiidle = "minutes": Time between idle-timer resets in minutes. Set to 0 to
280 # disable.
281 #
282 # Default: 0
283 #
284 # Example:
285 #antiidle = "300"
286
287
288 # qloglength = "minutes": Age of oldest line in quicklog in minutes. Set to zero
289 # to disable quicklog.
290 #
291 # This option might not be compiled in.
292 #
293 # Default: 30
294 #
295 # Example:
296 #qloglength = "30"
297
298
299 # timestamp = "option": Location of timestamp in quicklog events. This option
300 # may be one of the following "beginning", "end", or "none".
301 #
302 # This option might not be compiled in.
303 #
304 # Default: none
305 #
306 # Example:
307 #timestamp = "beginning"
308
309
310 # flushqlog = "state": If set to true, quicklog will be written only when no
311 # clients are connected and quicklog will be erased when client
312 # connects to miau. If you are running a single client, you
313 # probably want to leave this to "false.
314 #
315 # This option might not be compiled in.
316 #
317 # Default: true
318 #
319 # Example:
320 #flushqlog = "true"
321
322
323 # inbox = "state": Enables logging private messages when no clients are
324 # connected to miau.
325 #
326 # This option might not be compiled in.
327 #
328 # Default: true
329 #
330 # Example:
331 #inbox = "true"
332
333
334 # nevergiveup = "state": If set to true, miau will reset "working"-status of
335 # servers to working when all are set to dysfunctional.
336 # Respectively, if set to false, miau will quit when all servers
337 # on the list have been set to dysfunctional.
338 #
339 # Default: true
340 #
341 # Example:
342 #nevergiveup = "false"
343
344
345 # norestricted = "state": If set to true, miau will not stay on server that
346 # forces user to have restricted-status (+r).
347 #
348 # Default: true
349 #
350 # Example:
351 #norestricted = "false"
352
353
354 # reconnectdelay = "seconds": Time (in seconds) between connection attempts.
355 # Minumun value is set to 1.
356 #
357 # Default: 10
358 #
359 # Example:
360 #reconnectdelay = "30"
361
362
363 # nickfillchar = "fill character": Character used to modify your primary nick
364 # when all defined nicks are already occupied. Note character is
365 # a single octet (byte) and if longer string is fed, only the
366 # first character is used.
367 #
368 # Example: When nickfillchar is set to '_', primary nick is "zak" and all
369 # defined nicks are occupied, next nicks tried are "zak_", "zak__",
370 # "zak___" and so on. When nick has grown too long, it will be shifted
371 # one characted to right (where shift is cyclic) - this means
372 # "zak______" will become "_zak_____", which, again, will become
373 # "__zak____".
374 #
375 # Default: _
376 #
377 # Example:
378 #nickfillchar = "^"
379
380
381 # maxnicklen = "length": Maximum nick length, used with nickfillchar.
382 #
383 # Default: 9
384 #
385 # Example:
386 #maxnicklen = 11
387
388
389 # usermode = "usermode(s)": Usermode that miau will request (if no clients are
390 # attached at the moment) from the server when connection to the
391 # server is established. Leave unset or set to empty to disable
392 # this feature.
393 #
394 # Default: none
395 #
396 # Example:
397 #usermode = "+i"
398
399
400 # forwardmsg = "command": miau can collect the (private) messages within three
401 # (3) minutes and pipe them into the program specified. Leave this
402 # unset or set to empty to disable this feature.
403 #
404 # Default: none
405 #
406 # Example:
407 #forwardmsg = "mail user@host"
408
409
410 # ignore = { "mask":"ignored" }: List of users whose private messages (PRIVMSG)
411 # and noticies (NOTICE) are ignored when no clients are attached
412 # to miau. When "ignored" is left undefined, it is assumed to be
413 # "true". Setting "ignored" to "false" means that this user will
414 # _not_ be ignored. This list is processed as a chain.
415 #
416 # Default: none
417 #
418 # Example:
419 #ignore = {
420 # "*@localhost":"yes"
421 # "zak*":"no"
422 #}
423
424
425 # privlog = "mode": Whatever private messages should be logged in nick-specific
426 # files. Can be one of "never", "detached", "attached", and
427 # "always".
428 #
429 # This option might not be compiled in.
430 #
431 # Default: never
432 #
433 # Example:
434 #privlog = "always"
435
436
437 # chanlog = { "channel(s)":"options":"logfile" }: List of channel logfiles.
438 #
439 # When channel is set to "*", line represents global log. When logging,
440 # if channel doesn't have entry of it's own in this list, it will use settings
441 # of global log and write log to it's own file. When defining global log,
442 # "logfile" is ignored. Each line can have multiple channels
443 # (like "#foobar,#miau").
444 #
445 # If logfile is left undefined, logfile will be named after the channel with
446 # possible postfix (see logpostfix). All lofiles are written in miau's work
447 # directory.
448 #
449 # Options consist of abritary set of following possibilities:
450 # j: log joins
451 # e: log parts (exits)
452 # q: log quits
453 # m: log messages (privmsg/notice)
454 # c: log mode changes (changes)
455 # n: log nick changes
456 # o: log misc events (other)
457 # b: log messages from miau (bouncer)
458 # a: log all of above
459 # A: log when a client is attached
460 # D: log when a client is detached
461 # C: log continuously (status of clients doesn't matter)
462 #
463 # This option might not be compiled in.
464 #
465 # Default: none
466 #
467 # Example:
468 #chanlog = {
469 # "#foobar":"a" # log everything on #foobar
470 # "#miau":"aD":"foo.log" # log everything to file "foo.log" when
471 # all clients are detached
472 # "*":"mjeq" # log only messages, joins, parts and quits
473 # by default
474 #}
475
476
477 # logpostfix = "postfix": When writing log to undefined logfile, each logfile
478 # consists of channel name followed by postfix. Postfix can be
479 # defined here.
480 #
481 # This option might not be compiled in.
482 #
483 # Default: no postfix
484 #
485 # Example:
486 #logpostfix = ".log"
487
488
489 # onconnect = { "mode":"target/data"(:"data") }: When miau connects and
490 # registers user to server, miau can send pre-defined messages.
491 # User can define miau to send normal messages (PRIVMSG), notices
492 # (NOTICE) or arbitrary messages.
493 #
494 # Mode can be one of the following:
495 # p: private message (PRIVMSG).
496 # n: notice (NOTICE). Should be used with services and automatons, but
497 # unfortunately some network services can't cope with notices.
498 # r: "raw" message. This means user must provide complete message to send
499 # to the server. Using raw message user has complete control over what
500 # is being sent. If you don't know what this is, you don't need this.
501 # When using modes "p" or "n", user must provide both message and target where
502 # as with raw messages only one parameter in addition to type should be given.
503 #
504 # This option might not be compiled in.
505 #
506 # Default: none
507 #
508 # Example:
509 #onconnect = {
510 # "p":"nickserv":"identify foobar"
511 # "n":"nickserv@services.host.net":"id raboof"
512 # "r":"OPER foo bar"
513 #}
514
515
516 # automodes = { "mask":"privilegded" }: List of people who are automatically
517 # given certain privilege on channel. Mask is given in form of
518 # "mode:nick!username@host/#channel" (where "mode" is a single
519 # character) and list is processed as a chain.
520 #
521 # This option might not be compiled in.
522 #
523 # Default: none
524 #
525 # Example:
526 #automodes = {
527 # "o:zak*!zak@client*-myisp.com/#channel":"yes"
528 # "o:zak*!*@evil.impersonator.net/#foobar":"no"
529 # "v:newbie*!*@ircnet.com/#newbie":"yes"
530 #}
531
532
533 # automodedelay = "seconds": Time (in seconds) after first queued mode change
534 # would take effect. During this period of time miau can collect
535 # more than one mode change and commit up to three at a time.
536 # Other situation reasonaly big value (like 30) here could prove
537 # useful is channel where there are stupid "auto-oping" bots.
538 # (Stupid bots do mode changes even if someone else did that
539 # already.)
540 #
541 # This option might not be compiled in.
542 #
543 # Default: 30
544 #
545 # Example:
546 #automodedelay = "60"
547
548
549 # cmdpasswd = "password": Password for remote commands. If this is 13 characters
550 # long, miau assumes it's crypted. Comment this out or leave it
551 # empty to disable remote commands. When sending miau a remote
552 # command, password _always_ begins with column (':') (if
553 # cmdpasswd is set to "foobar" (or hash of it), you need to send
554 # miau a message beginning with ":foobar" to issue a remote
555 # command).
556 #
557 # This feature might not be compiled in.
558 #
559 # If miau is compiled with ENABLE_MKPASSWD, miau can generate password-hashes
560 # (from command line) with -c -switch.
561 #
562 # Default: disabled
563 #
564 # Example:
565 #cmdpasswd = ""
566
567
568 # dccbounce = "state": miau can bounce DCCs. Set to true to enable bouncing.
569 # You probably don't need this.
570 #
571 # This option might not be compiled in.
572 #
573 # Default: false
574 #
575 # Example:
576 #dccbounce = "true"
577
578
579 # dccbindhost = "host": If miau has separate IPs for IRC-network and clients,
580 # you should enter IP for clients here.
581 #
582 # This option might not be compiled in.
583 #
584 # Default: no default
585 #
586 # Example:
587 #dccbindhost = "10.0.0.1"