   _____    __     ___     ___
   \_   \  /__\   / __\   / __\  ___   _   _  _ __    ___   ___
    / /\/ / \//  / /     /__\// / _ \ | | | || '_ \  / __| / _ \
 /\/ /_  / _  \ / /___  / \/  \| (_) || |_| || | | || (__ |  __/
 \____/  \/ \_/ \____/  \_____/ \___/  \__,_||_| |_| \___| \___| v2.0a

Please read this document before emailing the author with questions.


(1) Introduction
    IRC Bounce is designed to be an IRC proxy server.  It was
    based on _Irc Proxy (c)1997-98 James Seter_.  IRC Bounce
    contains the following features:

     * User configurable via the file bnc.conf
     * Multi-user
     * Password capable (RFC 1459 compliant)
     * Supports ident spoofing when used in conjunction
       with an identd that allows users to choose the
       ident they wish to use
     * Virtual host support
     * Creates a pid file for crontab/bncchk use
     * Keeps a log file with basic information, errors, and who
       uses the bouncer
     * Admin can see who's online, and kill unwanted connections
     * No longer creates a PID for each user

    Features to be added in the near future:

     * Multiple accounts for added security (admin can check to
       make sure that people aren't giving out their account)
     * Anything else requested :)

(2) Compilation
    To compile the proxy, simply type 'make'.

(3) Configuration
    The configuration file (bnc.conf) contains the information
    needed to run IRC Bounce.  Instructions are included in the
    included example. Multiple vhosts can be specified, by using
    multiple V: configuration lines.

(4) Loading
    Running the proxy is very easy.  Simply confirm that the
    configuration file is setup (see section 3) and type './bnc'.
    You can also crontab the bouncer.  To do so, edit the file
    'bncchk' and set the variable "bncdir" to the directory which
    contains the bouncer and configuration file.  Then add the
    following line to your crontab (replacing "/home/mydir/" with
    the path where you installed the bouncer):

      0,10,20,30,40,50 * * * *   /home/mydir/bncchk  >/dev/null 2>&1

    If you've never used crontab before, here's a quick way to add
    that line:  Create a new file called 'mycron' and put the above
    line into it. Then, from your shell prompt, type 'crontab mycron'.
    That will create a new crontab entry for you, with a line that
    runs bncchk every ten minutes.  Bncchk will then restart the
    bouncer if it is found to be offline.

(5) Client Side
    Using your favourite IRC client, connect to the server from which
    the proxy daemon was run.  In ircii and similar clients, prefix
    commands to send to the proxy with "/quote" (eg. /quote ident user).
    In mIRC, prefix commands with "/raw".  To connect the the bouncer,
    a password will be required if one was defined in 'bnc.conf'. See
    the documentation for the client you are using for instructions
    how to connect to an IRC server which is password protected (the
    proxy follows the irc protocol for passwords (See RFC 1459). Most
    will use "/server bnc.server.com port pass".
    
    Once connected, you will be presented with an information screen
    showing the current client settings. Follow the on-screen
    instructions to change these settings.  When you are satisfied with
    the options, give the command "conn irc.server.net port password"
    (prefix this as described above).  The proxy will attempt to connect
    to the server you specified, and create a link between you and the
    IRC server.

(6) Legal Stuff
    IRC Bounce is copyright (c) by v00d00 Net Services. This program is
    distributed according to the GNU General Public License. There should
    be a copy of this license in the file COPYING.  If not, write to the
    Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
