Mercurial > xib
comparison README @ 28:6481b9bb95aa
Added documentation for the "say_level" attribute.
Signed-off-by: Charly COSTE <changaco@changaco.net>
| author | Charly COSTE <changaco@changaco.net> |
|---|---|
| date | Fri, 21 Aug 2009 00:58:47 +0200 |
| parents | 32a35f7eff70 |
| children | e7766a49b199 |
comparison
equal
deleted
inserted
replaced
| 27:9b7a628ca612 | 28:6481b9bb95aa |
|---|---|
| 41 Copy "example_config.xml" and modify it to fit your needs. | 41 Copy "example_config.xml" and modify it to fit your needs. |
| 42 | 42 |
| 43 | 43 |
| 44 > The different modes of the xib bots: | 44 > The different modes of the xib bots: |
| 45 | 45 |
| 46 Mode is a per-bridge attribute, it can take three values: | 46 "mode" is a per-bridge attribute, it can take three values: |
| 47 - 'normal': | 47 - 'normal': |
| 48 The bot connects on IRC on behalf of XMPP users and connects on XMPP on behalf of IRC users. | 48 The bot connects on IRC on behalf of XMPP users and connects on XMPP on behalf of IRC users. |
| 49 In this mode the bot automatically switches from normal to limited mode and back again when the IRC server clones limit is crossed. | 49 In this mode the bot automatically switches from normal to limited mode and back again when the IRC server clones limit is crossed. |
| 50 - 'limited': | 50 - 'limited': |
| 51 The bot only connects on XMPP on behalf of IRC users but NOT on IRC on behalf of XMPP. | 51 The bot only connects on XMPP on behalf of IRC users but NOT on IRC on behalf of XMPP. |
| 52 - 'minimal': | 52 - 'minimal': |
| 53 The bot does not connect on behalf of the participants. | 53 The bot does not connect on behalf of the participants. |
| 54 | 54 |
| 55 | 55 |
| 56 > Configure what the bot says on rooms: | |
| 57 | |
| 58 "say_level" is a per-bridge attribute, it can take 6 values, each value contains the ones below itself: | |
| 59 - 'all', default value, say everything | |
| 60 - 'info', contains participants' joining and leaving events in limited and minimal modes | |
| 61 - 'notice' | |
| 62 - 'warning', contains nickname conflicts and everything that is not fatal to the bridge | |
| 63 - 'error' | |
| 64 - 'nothing', don't say a word | |
| 65 | |
| 66 | |
| 56 > How to log xib bots output: | 67 > How to log xib bots output: |
| 57 | 68 |
| 58 xib does not directly handle logging for now so you have to do it the old school way, for example: | 69 xib does not directly handle logging for now so you have to do it the old school way, for example: |
| 59 mkdir /var/log/xib | 70 mkdir /var/log/xib |
| 60 touch /var/log/xib/1.log | 71 touch /var/log/xib/1.log |
