Mercurial > xib
changeset 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 | 9b7a628ca612 |
| children | a694ffe6a973 |
| files | README example_config.xml |
| diffstat | 2 files changed, 17 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/README +++ b/README @@ -43,7 +43,7 @@ Copy "example_config.xml" and modify it > The different modes of the xib bots: -Mode is a per-bridge attribute, it can take three values: +"mode" is a per-bridge attribute, it can take three values: - 'normal': The bot connects on IRC on behalf of XMPP users and connects on XMPP on behalf of IRC users. In this mode the bot automatically switches from normal to limited mode and back again when the IRC server clones limit is crossed. @@ -53,6 +53,17 @@ The bot only connects on XMPP on behalf The bot does not connect on behalf of the participants. +> Configure what the bot says on rooms: + +"say_level" is a per-bridge attribute, it can take 6 values, each value contains the ones below itself: +- 'all', default value, say everything +- 'info', contains participants' joining and leaving events in limited and minimal modes +- 'notice' +- 'warning', contains nickname conflicts and everything that is not fatal to the bridge +- 'error' +- 'nothing', don't say a word + + > How to log xib bots output: xib does not directly handle logging for now so you have to do it the old school way, for example:
--- a/example_config.xml +++ b/example_config.xml @@ -2,10 +2,14 @@ <config> <bot jid='some_bot@example.net' password='do not forget to escape xml entities like &' nickname='xib-bot-nickname' debug='true'> <!-- WARNING: do NOT set debug to "true" if you are sending the bot's stderr to a file, it logs every XMPP stanza and IRC event without controlling the size of the resulting file --> - <bridge mode='normal'> + <bridge mode='normal' say_level='all'> <xmpp-room jid='dream-world@chat.example.com'/> <irc chan='#dream-world' server='irc.example.org'/> </bridge> + <bridge mode='minimal' say_level='nothing'> + <xmpp-room jid='room@chat.example.com'/> + <irc chan='#chan' server='irc.example.org'/> + </bridge> </bot> <!-- WARNING: do NOT start two bots with the same JID or the same nickname --> <!-- WARNING: two bots connecting to the same XMPP MUC server and/or the same IRC server may conflict, it is better to use multiple bridges -->