Internet Relay Jabber

File Release Notes and Changelog

Release Name: 0.0.1

Notes:
NAME
    IRJ - Internet Relay Jabber

REQUIREMENTS
    Perl Perl 5.x, Net::Jabber, and Net::IRC.

    A Jabber account.
         IRJ does not (yet) handle the process of signing up for a
         Jabber account, so you will need to download a "normal"
         Jabber client (like MyJabber) and sign up that way. You
         will also need to use a Jabber client to sign up for
         Gateways (like MSN, Yahoo, etc).

    IRC Server
         An IRC server that allows you to run bots. Preferably one
         with ChanServ and NickServ so you can make sure you and the
         IRJ bot are the only ones allowed in the channel (unless
         you like people listening in on your conversations).

CONFIGURATION
    Configuration is through the `%GLOBALS' hash at the top of the
    irj.pl file.

    jabberserver
         Jabber server you want to connect to.

    jabberport
         Port that the Jabber server is running on. Usually 5222.

    jabberusername
         Your username on the Jabber server.

    jabberpassword
         Your password on the Jabber server.

    ircserver
         The IRC server you want to connect to.

    ircport
         Port that the IRC server is running on. Usually 6667.

    ircnick
         The nickname that you want IRJ to use on IRC

    ircchannel
         The channel you want IRJ to run in (Needs to include the #)

    ircconnectscript
         Script with RAW IRC commands to run when you first connect.
         Useful for interacting with NickServ/ChanServ. One RAW IRC
         command per line. A blank line will cause the script to
         pause for one second. For example, to identify yourself to
         NickServ, then have ChanServ invite you to #IRJ, use the
         following script.

                 PRIVMSG NICKSERV IDENTIFY password

                 PRIVMSG CHANSERV INVITE #IRJ

         If the script file cannot be opened or no file is
         specified, IRJ will skip this step without error.

    ircowner
         The nickname(s) of the "owner" of the IRJ IRC bot. The bot
         will only accept input from these names. This list is also
         used to determine when to mark the Jabber user as being
         'Available', which will only happen when one of the nicks
         is present in the channel IRJ uses. There can be as many or
         as few nicks as you like.

    msn_auto_nick
         This option should be either 1 (on) or 0 (off). MSN Instant
         Messenger has an interesting feature that allows a user to
         specify what nickname will show up on other people's
         "Contact List". Enabling this feature will cause IRJ to
         automatically update your Jabber roster to reflect what
         nickname an MSN user is using.

    debug
         This option is either 1 (on) or 0 (off). When turned on,
         IRJ will print (to STDOUT) everything sent to the IRC
         channel or to the Jabber server plus other debugging
         messages. When turned off, IRJ will say nothing unless a
         serious error occurs.

USAGE
    The program takes no arguments, so just start it up. It will
    connect to the IRC and Jabber servers specified in the
    configuration.

  Chatting

    To chat with a user that is on your Jabber roster, type the
    first few letters of their nickname or JID (Jabber ID), then a
    colon, then your message. For instance: `Mr_Person: Greetings!'.
    You only need to type enough of their name for it to be unique
    from the other names in your roster. Also if you like you can
    prefix the name with a `!' instead of putting a colon after it.

    After you have started talking with a user, all further messages
    that do not specify a recipient will be sent to that user. IRJ
    will change the channel topic to indicate which user you are
    talking with just in case you foget.

  Bot Commands

    The IRJ bot supports several commands. Commands should be sent
    to is via private message (/msg on most IRC clients). For
    example, `/msg IRJ !allstatus'.

    !die or !ifeelhappy
         Terminates IRJ.

    !away Reason
         Sets your presence to "Away" and your status to whatever
         you entered.

    !extendedaway or !exaway or !xa Reason
         Sets your presence to "Extended Away" and your status to
         whatever you entered.

    !dnd or !donotdisturb Reason
         Sets your presence to "Do Not Disturb" and your status to
         whatever you entered.

    !back
         Sets your presence to "Available".

    !subscribe JID
         Sends subscriptions request to the JID you entered.

    !subscribed JID
         Allows subscription from the JID you entered.

    !unsubscribe
         Sends unsubscription request to the JID you entered and
         unsubscribes you from them.

    !nick JID Nickname
         Sets the nickname in your roster for the JID you entered to
         the nickname you entered. The nickname will appear in
         conversations instead of the JID if one is specified.

    !delnick or !deletenick or !removenick JID
         Deletes the specified JID from your roster.

    !allstatus
         Shows the JID, Nickname (if specified), Presence, and
         Status for all JIDs in your roster.

LICENSE
    Copyright (C) 2002 Curtis "Mr_Person" Hawthorne

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License as
    published by the Free Software Foundation; either version 2 of
    the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
    General Public License for more details.

    You should have received a copy of the GNU General Public
    License along with this program; if not, write to the Free
    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
    MA 02111-1307 USA

AUTHOR
    Curtis "Mr_Person" Hawthorne, mr_person@users.sourceforge.net



Changes:
Version 0.0.1 - June 24, 2002
-----------------------------
Initial relase.