| Index: trunk/extensions/XMLRC/client/README |
| — | — | @@ -0,0 +1,30 @@ |
| | 2 | +This directory contains an XMPP client program/library for receiving and |
| | 3 | +processing XMLRC messages, namely rcclient.py. If run standalone, it will |
| | 4 | +listen for RC messages, analyze the XML data and print the information |
| | 5 | +if found to the shell. |
| | 6 | + |
| | 7 | +When used as a library, rcclient provides a class for listening for |
| | 8 | +messages, RCClient. Implementations of RCHandler can be registered with |
| | 9 | +the client, and will be called for every RC message received. |
| | 10 | + |
| | 11 | +NOTE: You can place this directory anywhere on your system. In fact, for |
| | 12 | +security reasons, it is recommended to move it to a location that is not |
| | 13 | +accessible from the web or by the web server. |
| | 14 | + |
| | 15 | +To use rcclient.py, you need python 2.5 and the xmpppy library from |
| | 16 | +<http://xmpppy.sourceforge.net/>. You also need an account on an XMPP |
| | 17 | +(Jabber) server for use by udp2xmpp.py. |
| | 18 | + |
| | 19 | +In order to configure rcclient for use with your wiki, rename |
| | 20 | +rcclient.ini.sample to rcclient.ini. Put the credentials for your XMPP |
| | 21 | +account into rcclient.ini (see comments inside). |
| | 22 | + |
| | 23 | +When everything is configured, you can start rcclient.py simply by typing: |
| | 24 | + |
| | 25 | + python rcclient.py |
| | 26 | + |
| | 27 | +If you want to join a chat room (that is, if udp2xmpp.py sends the messages |
| | 28 | +to a chat room), you have to specify the romm's JID: |
| | 29 | + |
| | 30 | + python rcclient.py recentchanges@conference.jabber.example.com |
| | 31 | + |
| Property changes on: trunk/extensions/XMLRC/client/README |
| ___________________________________________________________________ |
| Added: svn:mergeinfo |