irssi-xmpp:
===========

homepage: http://cybione.org/~irssi-xmpp/

About:
======

irssi-xmpp is an irssi plugin to connect to the Jabber network.

Its main features are:
    o Sending and receiving messages in irssi's query windows
    o A roster with contact & resource tracking (contact list)
    o Contact management (add, remove, manage subscriptions)
    o MUC (Multi-User Chat)
    o Tab completion of commands, JIDs and resources
    o Message Events ("composing")
    o Support for multiple accounts
    o Unicode support (UTF-8)
    o SSL and HTTP proxy support
    o ...

To deal with the XMPP protocol, it uses of the Loudmouth library.
Written in C and released under the GNU General Public License version 2.

Installation:
=============

Requirement:
    o Loudmouth (>= 1.2.x): http://www.loudmouth-project.org/
    o Irssi (>= 0.8.13) and its sources unpacked and configured:
      http://irssi.org/

Procedure:
    o edit the file "config.mk" if needed and export this environment
      variable:
            $ export IRSSI_INCLUDE=/path/to/irssi/sources
    o build the sources:
            $ make
    o install the module:
        - in your home directory:
            $ make user-install
        - in the base system:
            # make install

Documentation:
==============

In the directory "docs/":
    o STARTUP: Getting started
    o GENERAL: How to use irssi-xmpp and related commands
    o MUC: How to use Multi-User Chat and related commands
    o FAQ: Frequently Asked Questions and Troubleshooting
    o XEP: XMPP Extensions supported
    o INTERNAL: How irssi-xmpp works

In the directory "help/" you can find the help files of each irssi-xmpp
specific commands, which can be viewed in irssi with the command /HELP.

Community/Bugs/Suggestions:
===========================

Mailing-list:           irssi-xmpp-list@cybione.org
    to subscribe:       irssi-xmpp-list+subscribe@cybione.org
    to unsuscibre:      irssi-xmpp-list+unsubscribe@cybione.org
    archives:		http://cybione.org/lists/irssi-xmpp-list/

Commits-list:           irssi-xmpp-commits@cybione.org
    to subscribe:       irssi-xmpp-commits+subscribe@cybione.org
    to unsuscibre:      irssi-xmpp-commits+unsubscribe@cybione.org

MUC room:               irssi-xmpp@chat.jabberfr.org
    archives:		http://chat.jabberfr.org/logs/irssi-xmpp@chat.jabberfr.org/?C=M;O=D

Bug tracker:		https://gna.org/bugs/?group=irssi-xmpp

If irssi crashes, please build irssi with debug symbols and the module
irssi-xmpp in debug mode (take a look at "config.mk" to activate it).
Then you can run irssi in gdb and print the backtrace ("bt full") when
irssi crashes.  Paste the backtrace in your message would help to fix
this bug.

Author:
=======

Colin Didier (cdidier@cybione.org, xmpp:cdidier@im.cybione.org)
