Cygnus -- README file

--

This document is intended to familiarize new users with Cygnus.
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  RootServ
        2.2.0  NickServ
        2.3.0  ChanServ
        2.4.0  MemoServ
        2.5.0  GlobalNoticer
    3.0.0  Supported IRCds
    4.0.0  Contact information

-----

1.0.0  General program information

Cygnus is a program designed for use on an IRC network. It provides the
network with four services: RootServ, which allows your staff to maintain
Services and the network, NickServ, which allows your users to register
and maintain their nicknames, ChanServ, which lets your users register
and maintain their channels, and MemoServ, which lets users with registered
nicknames send memos to eachother. Cygnus is also designed to work along
it's sister program, OperStats. OperStats provides an IRC Operator service,
as well as a Statistical Service. You can view more information about
OperStats at http://www.habber.net/services/operstats.

Cygnus 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 Cygnus 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 Cygnus uses to interface with the
users of the network. Each has a specialized purpose.

--

2.1.0  RootServ

RootServ allows the network's IRCOps to do a variety of things, such as
managing AutoKills and server/nick JUPEs. It also allows services admins
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  NickServ

NickServ allows your users to register their nicknames. Once registered,
these users have ownership of their nickname. If told to, NickServ will
keep other users from using a registered nickname. Users with registered
nicknames are also able to register channels with ChanServ, and send and
receive memos with MemoServ.

--

2.3.0  ChanServ

ChanServ lets your users register channels. Channel founders can add other
users to the channel's access list. Users on the access list will op, voice,
halfop, and kick users depending on their access. Channel founders can also
have ChanServ keep certain modes set/unset, as well as keep one topic set or
restrict who can change the topic.

--

2.4.0  MemoServ

MemoServ lets users with registered nicknames send memos to eachother.
If services is properly configured, MemoServ also has the ability to E-Mail
memos to users.

--

2.5.0  GlobalNoticer

The GlobalNoticer is a highly specialized client. It doesn't reply to any
queries, and can only be accessed indirectly through RootServ Any global
notices sent with the GLOBAL command will be dispatched with this client,
as well as several other messages Services uses to communicate with your
users.

--

3.0.0 Supported IRCds

Cygnus 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 Cygnus with it. Configure Cygnus 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

Here's the deal. I enjoy making these services, and I do it for free.
You didn't pay anything for these, did you? No. My time and effort went
into making this program, and now you want me to help you set it up, too.

Well thats ok, but do me a favor, first. READ THE DOCS. Unlike many other
coders, I've included some fairly extensive documentation. The conf file
has an in depth description of every conf option, as well as examples of
how its used, what it does, and what happens if you turn it on or off.
Various files in the doc/ directory explain other functions of Cygnus,
such as how to use the Network News feature, how to modify the .email
files, and even how to read the log files. So PLEASE don't waste my time
by asking me asinine questions which are clearly answered in the docs.
You'll just annoy me and make me regret making these services so easy
to set up and use that they require no intelligence (which you'll be
labelled as lacking if you ask me stupid questions.)

That said, if you've skimmed the docs and can't find your answer, feel
free to ask. I'll point you to the file that has your answer. I've been
unable to find the answer I was looking for in many programs myself, so
I don't mind this kind of question.

Just don't ask me to set them up for you. "Set up services for a man,
and you make him go away for a day.. Teach a man to set up services
himself, and you make him go away forever." :P

Anyhow, 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.
