             README for the IRC-Services ElementServ for the P10-Protocol
Yeah, welcome and thank you for choosing ElementServ. There is no special name
for this tool atm, but you can send suggestions to flohinz@aol.com .


INSTALLATION

See the INSTALL file for more information.


INFORMATIONS

What does this service do? It's quite simply yet. It connects to the uplink with 2
clients, C and O atm.
C is a simple ChanServ with an auth-system and a badword
function. Badwords can be set for all channels or for a single channel; if there
is one detected the bot kickbans the user from the channel.
O is the base for an OpServ. It can broadcast to all users, kill a single user
and SQUIT the service.
Both services will be expanded. See TODO section for some information.


SIMPLE COMMAND OVERVIEW

C commands:
- register: creates an auth (usage: MSG <C-nick> register <name> <password>)
- auth: auths a user to an exisisting account
   (usage: MSG <C-nick>@<C-host> auth <name> <password>)
- talk: sends a useless message to channel #locNet (this channel will be joined on
   every connect)
- join: joins a channel (usage: MSG <C-nick> join <#channel> [opers only])
- part: parts a channel (usage: MSG <C-nick> part <#channel> [opers only])
O commands (all commands are only usable by opers):
- broadcast: sends a message to all connected clients. Notice: for technical
    reasons the broadcast-message must not contain a ':'.
   (usage: MSG <O-nick> broadcast <message>)
- kill: kills a user (usage: MSG <O-nick> kill <user> <reason>)
- die: SQUIT the services


TODO

A list of things that should be done before adding new features:
- detecting authed users on connect and save the auth into the db
A list of functions that will be added after bugfixing:
- add (basic) channel management for C. Userflags are:
  + owner (only 1 allowed per chan; == founder)
  + coowner (nearly the same as owner, can do anything exept delete the chan
     and removing the owners account)
  + master (can add timed/perm bans, ops, voices and some more)
  + op (can add only timed bans)
  + voice (gets only voice; no other rights)
- use authlevs for C
- add GLINE function for O
- use authlev for O (using C's authlevs)
- if a server splits off, also delete the clients that were connected on it