# +-------------------------------------------------------------------------------------+
# |                                                                                     |
# |                         a&a (light) script v0.03.02 Alpha                           |
# |                                                                                     |
# +-------------------------------------------------------------------------------------+
# |                                                                                     |
# |             Creative Commons Copyright 2002-2005 by universalia aka aqwzsx          |
# |                               http://ascript.name                                   |
# |                                                                                     |
# +-------------------------------------------------------------------------------------+
# |                                                                                     |
# |        Project             @  http://ascript.name                                   |
# |        Forum               @  http://forum.ascript.name                             |
# |        Features request    @  http://features.ascript.name (category a&a)           |
# |        Support request     @  http://support.ascript.name (category a&a)            |
# |        Bugs report         @  http://bugs.ascript.name                              |
# |        CVS pserver         @  cvs.sourceforge.net:/cvsroot/scripting co -P a&a      |
# |        CVS Web repository  @  http://cvs.ascript.name (folder a&a)                  |
# |                                                                                     |
# +-------------------------------------------------------------------------------------+
# |                                                                                     |
# |                            #a&a @ Undernet/Quakenet IRC                             |
# |                                                                                     |
# +-------------------------------------------------------------------------------------+
######################################################

Info about script, how to use it, where to look for support, etc etc

############ Where to get support/info ###############

For support join #a&a & #botlending @ Undernet/Quakenet IRC. Also you can give questions
in forum @ http://forum.ascript.name. 

Info about flags, you can find @ http://www.starbots.info/flags
Info about channel settings, you can find @ http://www.starbots.info/settings
Info about commands, you can find @ http://www.starbots.info/commands

############ 1st steps ###############################

If you are the owner of the BOT, you must have created your user on bot as described in 
INSTALL, with the command 'hello'. Do not forget to make yourself manager with the command
'promote', as described in INSTALL.

You must authorise before giving any command. For authorisation use the command 'auth'
(like: /msg BOT auth pass). 

To view available commands on BOT - use the command !commands
Explication for any command - use the command !help COMMAND
Syntax for any command - use the command !usage COMMAND

############ to command the BOT

You can give commands on BOT in a few different ways. By default (as specified in
'settings(cmdpfix)' in settings.conf) the commands are prefixed with "! . `". Then the 
sintax for a command will be like this: !op, .op, `op.
Also you can command the bot using its NICK (like: BOT op)
Also you can give commands messaging the BOT (like: /msg BOT op #channel)
If you are on channel #a & want to give a command for channel #b - it's enough to specify
channel name (on channel #a like: !op #b)
If you want to give a command to a group of bots - use the prefix 'for' 
	(like: for bot1 bot2 bot3:op)
If you want to give a command to all bots but skip some bots - use the prefix 'skip'
	(like: skip bot1 bot2 bot3:op)
If you have 'settings(cmd_me)' enabled in settings.conf - you can give commands with 
	action (like: /me op)

############ to give access

To give access to smbd locally - use the command !chattr (like: !chattr NICK +of)
	* if the user doesn't exist, the BOT will autoadd it itself
To give access to smbd globally - use the command !chattrgl (like: !chattrgl NICK +of)
	* if the user doesn't exist, the BOT will autoadd it itself
To make smbd channel manager - give him +Nf flags (like: !chattr NICK +Nf) 
To remove acces to smbd locally - use the command !remuser
To delete an user on bot - use the command !deluser
To add an user - user the command !adduser

When you give local access, the user will have acces on BOT only on specified channel &
will not have access to global commands. If you give access globally, the user will have
access on all channels & will have access to all global commands. Give global access to a
limited number of ppl & *ONLY* trusted one.

############ to join/purge/view channels

To make the BOT join a channel - use the command !join (like: !join #CHANNEL) 
To make the BOT part a channel permanently - use the command !purge 
	(like: !purge #CHANNEL reason)
To make the BOT part a channel temporarily - use the command !templeave 
	(like: !templeave #CHANNEL reason)
To make the BOT to comeback the channel after templeave - use the command !comeback
	(like: !comeback #CHAN)
To view channel list on BOT - use the command !channels 
	(like: !channels)

############ channel settings

To setup a channel - use the command !chanset (like: !chanset +voice) 
To view all channels settings - use the command !chaninfo -all

############ user settings

To setup an user on BOT - use the command !userset
To view user settings - use the command !userinfo
To view user info - use the command !whois

############ using stats

To view why a BOT purged the channel or if it was there - !stats #CHANNEL purge
To view why a BOT templeft a channel - !stats #CHANNEL tempelave
To view channel stats - !stats #CHANNEL all
To view a particular stats - !stats #CHANNEL users, !stats #CHANNEL traffic, etc etc

############ homechan channel (known also as console)

If you want the BOT to report any abuse like deop, ban, kick, no-access etc etc - you 
have to enable 'settings(report)' in settings.conf.
If you enable 'settings(paranoia)' from settings.conf - 1st the BOT will join the home
channel & after having logged to X/Q/etc, will join the other channels.

+secret channels will be shown only on homechan or in private.
!whois information about global admins will be shown on homechan or in private.