File	Date	Author	Commit
IRC-Transport-Howtouse.html	2004-05-20	Mike Albon	[46eee2] Inital import of user documentation.
README.txt	2006-05-21	Norman Rasmussen	[9275b4] migrated to xml configuration file, and added a...
adhoc.py	2007-12-18	Norman Rasmussen	[c29ef9] Add labels to remaining form fields. Force ser...
config.py	2007-07-22	Norman Rasmussen	[b4baea] Added option to require users to register befor...
config_example.xml	2007-07-22	Norman Rasmussen	[b4baea] Added option to require users to register befor...
irc.py	2010-01-17	Norman Rasmussen	[d35d19] Merge branch 'master' of github.com:normanr/irc...
irc_helpers.py	2006-09-20	Norman Rasmussen	[435015] move irc_ulower to irc_helpers
irclib.py.diff	2004-05-20	Mike Albon	[e448f6] Fixed Diff to reflect current use and all cases.
jep0133.py	2007-07-22	Norman Rasmussen	[ec1193] Added service admin commands for adding and del...
xmlconfig.py	2006-05-21	Norman Rasmussen	[9275b4] migrated to xml configuration file, and added a...
xmpp-irc	2004-06-16	Alexey Nezhdanov	[a3312b] VEEERY preliminary (but working) version of ini...

Read Me

XMPP IRC-Transport Readme.
==========================


Installing the transport:
-------------------------

To install the transport you need a copy of the xmpppy (by Alexey Nezhdanov) library on your system and a copy of the irclib (by Joel Rosdahl). You can find both of these at the following addresses:

http://xmpppy.sourceforge.net
http://python-irclib.sourceforge.net

To make the irclib library integrate with the transport more effectively you need to patch it with the supplied diff file: irclib.py.diff.  (patch <irclib.py.diff works for me). This allows the external select function without needing lambda functions. This is required for the transport to operate.

Configure the Transport:
------------------------

To configure the transport you need to modify your jabber server configuration to expose the irc-transport to users. The transport itself has a configuration file which it reads on startup.  A sample configuration file is provided, copy it as config.xml and change the settings as required.

The default Python Encoding:
----------------------------

Some people may have set the python site.py encoding to something other than ascii. The transport relies on this being a non-unicode value, if you have set this to utf-8 it may not work.

Thanks to:
----------

The Jabber.org.uk crew who let me abuse their server while doing testing.
Alexey Nezhadanov for his help and the library.
Joel Rosdhal for the irclib library.