OperStats -- README file

--

This document is intended to familiarize new users with OperStats.
For installation help, see the INSTALL file.

If you have any questions about this program not covered in any of the
documentation, or need help with the general operation of this program,
ask in #Services on HabberNet (irc.habber.net).

-----

Contents:

    1.0.0  General program information
    2.0.0  Pseudo-clients
        2.1.0  OperServ
        2.2.0  StatServ
        2.3.0  GlobalNoticer
	2.4.0  SpamServ
    3.0.0  Supported IRCds
    4.0.0  Contact information

-----

1.0.0  General program information

OperStats is a program designed for use on an IRC network. It provides the
network with two main functions: OperServ, an IRC Operator service, and
StatServ, a statistical service. This is all it does; there will never be
a channel service, nickname service, etc; however there is a companion
program (Cygnus) which works alongside OperStats and provides these services.

OperStats emulates a server on the IRC network. It also replies to a
variety of IRC commands, such as WHOIS, MOTD, INFO, VERSION, and many
others. It tries to appear to be a real server, not simply a program
emulating one.

Although OperStats isn't directly based on any other program, it borrows
heavily from Andrew Church's IRCServices program; The majority of the basic
code is taken directly from there.

--

2.0.0  Pseudo-clients

There are several pseudo-clients that OperStats uses to interface with the
users of the network. Each has a specialized purpose.

--

2.1.0  OperServ

OperServ allows the network's IRCOps to do a variety of things, such as
managing AutoKills and server/nick JUPEs. It also allows OperStats
admin(s) to perform several maintenance functions. It's the main interface
between your staff and the program. Only IRCOps can access this service,
regular users cannot use it.

--

2.2.0  StatServ

StatServ has several functions available only to IRCOps, and several
available to normal users, such as seeing general statistics on the
network or doing a TLD lookup. IRCOps have access to additional commands,
such as seeing a MAP of the servers or getting statistics on a specific
server. OperStats admin(s) have several maintenance functions available,
such as managing the server list or resetting a server's statistics.

--

2.3.0  GlobalNoticer

The GlobalNoticer is a highly specialized client. It doesn't reply to any
queries, and can only be accessed indirectly through OperServ (or
StatServ, if you have configured OperStats this way). Any global notices
sent with the GLOBAL command will be dispatched with this client, as well
as any LogonMSGs you have.

--

2.4.0  SpamServ

SpamServ is the spam detection bot. It merely sits on your network,
fully visible and not in any channels, waiting to be messaged. The only
way someone can become aware of its existance is through a /who. This is a
common spamming technique, doing a /who and spamming everyone in the who
reply. Anything this client gets via MSG is globopped. Text IRCOps send to
it is not globopped however.

--

3.0.0 Supported IRCds

OperStats currently only explicitly supports 5 IRCds; Support for more
may be added later. If your IRCd of choice is not listed here, E-Mail me
at skold@habber.net, and let me know the name of your IRCd and where I
can obtain a copy of it. This doesn't gaurantee support for your IRCd
though, but I will try.

  Supported:

     IRCd:               Version:               Problems:
     -----               --------               ---------

     DreamForge          Any                    None

     UnrealIRCd          3.1+                   None

     Prometheus          2.0.0+                 None

     Bahamut             Any                    None

  Unsupported:

     IRCd:               Version:               Problems:
     -----               --------               ---------

     HybridIRCd          Any                    Not supported; Will not work.

     IRCu                Any                    Not supported; Will not work.

     UltimateIRCd        Any                    Configure for DreamForge;
                                                No gaurantees.
     EliteIRCd           Any                    Configure for DreamForge;
                                                No gaurantees.
     RageIRCd            Any                    Configure for DreamForge;
                                                No gaurantees.
     IRCNet IRCd         Any                    Not supported; Will not work.

     Base IRCd           Any                    Not supported; Will not work.

If your IRCd is based on any of the supported IRCds, you may have a good
chance of success using OperStats with it. Configure OperStats for the
IRCd yours is based on. If you have any IRCd-related problems, tough
luck; I may add explicit support for your IRCd in a later version, but
don't expect it the next day. Contact your IRCd's maintainer if you are
unsure of it's ancestry.

--

4.0.0 Contact information

Feel free to contact me in regards to this program, I welcome
(most) comments on it. Feel free to suggest changes or new features.

I also accept donations :)

You can contact me via any of these methods, (Preferred order):

  Message Board:
     http://www.habber.net/board

  IRC:
     irc.habber.net; skold; #Services

  E-Mail:
     skold@habber.net

If you are trying to contact me in regards to a bug in this program,
please see doc/bug-report. Fill out the form as best you can, and submit
it as per the instructions on the form.
