	XDCC 1.0 - by Keyoke (keyoke@falcon.inetnebr.com)


(Sorry fellas, I'm definatly NOT a document writer) :)
First of all, I'd like to quicly go over the things this script is designed
to do, and what it's NOT designed to do, and then give a quick features
list. Later on in the doc, I'll tell you how to use XDCC more effectively,
(search for "XDCC Tips" if you'd like to skip there now.)

XDCC Was designed to offer a small amount of files to the general public
without them having to enter the bot's file areas. It works just like the
popular ircII script's (like LiCe & Phoenix) XDCC functions, with a few
notable enhancements (I'll cover those in a sec). 

XDCC Was NOT designed to offer large quantities of files. That has a habit
of "flooding" the channel, and causing chaos.. 


Features:
	Some of the XDCC Features include:
*	Automatic Pack renumbering - Renumbers your packs on the fly after
	an addition or deletion of a file from the list.
*	Automatic Public Listing   - Publicly lists your files every <xxx>
	minutes. This can be turned on/off, and can be configured.
*	Recognition of XDCC commands via MSG's and CTCP's. 
*	Displays File Size, File name, Pack number, Description and Note
	(optional).

Bugs:
* 	Hopefully, I've fixed them all. ;)

XDCC Commands:

	Here's a quick list on the avalible commands, and how to use them.

DCC COMMANDS:
Avalible to MASTERS and OWNERS via DCC.

Command:	ADD - Ads files to the XDCC list.
Syntax:		.xdcc add <file> <description> <note>
NOTE:		Descripions and notes MUST be enclosed in quotes. 
		The "note" feild is optional.

Command:	DEL - Removes file from the list.
Syntax:		.xdcc del <number>
NOTE		the Number feild is the Number of the pack u wish to delete.

Command:	WIPE - Restarts XDCC, remvoes ALL files.
Syntax:		.xdcc wipe
NOTE:		This command will COMPLEATLY reset XDCC, turns off Auto
		Plist, and resets the delay to 0. 	

Command:	PON - Turns ON Auto-public listing.
Syntax:		.xdcc pon
NOTE:		This command turns on automatic public listing. If there has 
		been no "interval" set, it defaults to 15 minutes.

Command:	POFF - Turns OFF Auto-public Listing.
Syntax:		.xdcc poff
NOTE:		Turns off Public listing. leaves the interval at last
		setting.

Command:	INTER - Sets Interval between public listings.
Syntax:		.xdcc inter <value>
Note:		Value feild is the time in MINUTES between public listings.

Command:	PLIST - Publicly lists files to the channel.
Syntax:		.xdcc plist
Note:		N/A

Command:	LIST - Lists the XDCC Files via DCC (must have master).
Syntax:		.xdcc list <number>
NOTE:		NUMBER is optional. If used, it will give detailed info on
		that pack number.

Command:	STATUS - Shows current XDCC Status.
Syntax:		.xdcc status
NOTE:		Shows Public Listing State, Delay between listings, and
		number of files avalible.

Command:	HELP - shows help. 
Syntax:		.xdcc help <command>
NOTE:		<command> is ioptional. If used, must be either "ADD, DEL,
		LIST, PON, POFF, INTER, STATUS or ABOUT".
Required: 	dcc.xdcc* need to be installed in your HELP directory.

MESSAGEABLE COMMANDS:
These commands can be accessed via a /MSG or a /CTCP to the bot.

Command:	LIST - Lists files.
Syntax:		/msg <bot> XDCC LIST or /CTCP <bot> XDCC LIST
NOTE:		Lists the files much like a public listing, except done by
		NOTICIES.

Command:	SEND - Sends File to user.
Syntax:		/msg <bot> XDCC SEND x or /CTCP <bot> XDCC SEND x
NOTE:		Sends pack x to user.

Command:	HELP - Shows help.
Syntax:		/msg <bot> XDCC HELP <cmd> or /CTCP <bot> XDCC HELP <cmd>
NOTE:		<cmd> feild is optional. If used, must be one of: "LIST,
		SEND, or HELP". 



When Something Goes Wrong:

	Scince XDCC is still in Beta, stuff is liable to go wrong. If it
does, check the logs and see what the bot puts in there. If it's a TCL error,
It's due to lack of sleep and thus, lack of attention to what I'm doing.
email me with the error message and I'll fix it ASAP. :)

	All "Trappable" errors (except for TCL internal errors) will be
reported. (hopefully). XDCC will put those errors in the log prefixed with
the line "*** XDCC 1.0 : <error message>" Detailed info will be left via a
note to whoever is listed as the bot's owner. (set $owner in the bot's
config file).

	The errors XDCC Traps for are:
		code 0 - No error, DCC Send attempted.
		code 1 - DCC Table full (to many connections)
		code 2 - Can't open socket. (I can't fix this).
		code 3 - Can't find file specified.
		code 4 - Qued file.
		
	Code 4 isn't really an error, but I put it in the log (no
	note for that one or code 0) because back in 0.9m, quing files 
	caused the bot to crash. It's more FYI than anything else.
	
	The notes you'll get won't be terribly descriptive. You'll get info 
on what the problem was, the nick of the user the error occured with, and
the name of the file requested.



XDCC Tips:

	Keep your XDCC avalible files to a minimum. This keeps the bot from
getting kicked out of the channel or banned because of flooding.

	Add a file with 0 bytes to the list with the description "More files
on the bot!" and the note "in a DCC Chat type: .help files for help!" to
advertise the files on your bot.

	

That's about it fellas, Like I said, I'm not much of a document writer, and
It's about 4:30am. ;) Sorry 'bout the spelling. ;)