   ____ _   _    _  _____    _        _
  / ___| | | |  / \|_   _|__| |_ __ _| |_ ___
 | |   | |_| | / _ \ | |/ __| __/ _` | __/ __|
 | |___|  _  |/ ___ \| |\__ \ || (_| | |_\__ \
  \____|_| |_/_/   \_\_||___/\__\__,_|\__|___/
              3.1.2 by Baerchen, February 2002
                  for eggdrop 1.4.5+ & TCL 8.3
                     baerchen@germany-chat.net
       latest versions @ home.dal.net/baerchen
       
CONFIGURATION
*********************************************************************

set cs(workdir) "/usr/home/bla/mybot/putallfileshere/"
Directory where CHATstats looks for the files it reads and writes
(data files, templates) Leave leading and trailing /'s as shown. Path
should not contain any dots ".".

set cs(trigger) "."
This defines what char has to be used in front of a channel command.
"" is a valid option but not recommended.

set cs(idle) 300
CHATstats counts people's idle seconds. Set this to what you consider
to be idle. Set to 0 to count each and every idle second. Set to a
very high value (like 100000000) to virtually disable this feature.

set cs(dont) "fserv type trigger"
If CHATstats finds one of the words of this space delimited list in
a user's line, it will not add the wordcount and the line to the
user's stats. You don't need to include the plural of words, e.g.
if you include "fserv" you don't need to add "fservs". Set to ""
to disable this feature.

---------------------------------------------------------------------

set cs(global) {

Here we start with the global configuration.
The global configuration represents the default settings for all
channels where CHATstats is enabled. The global config includes all
settings the script offers. In opposite, if you need different
settings for a channel, you will need to create a channel specific
variable that contains only the changed settings. These settings will
override the global ones. We'll see later, here's the global config
first (note the different notation):

post=2
Determine how the command "show" is posted to the user:
0 = Don't post anything, tell users to visit the channel's website
1 = PRIVMSG to the channel
2 = NOTICE to the user
3 = MSG to the user
Getting info MSG'ed is very annoying and prevents users from calling
info too often while NOTICE seems to be the least spamming way.

rankrange=10
This defines how many ranks are shown in a ranking on IRC.

timebalance=+0
Is your channel German and your bot resides on a server in the US?
Then all shown times (e.g. activity stats) refer to the US time,
which is probalby not what you want. People would see that there
is highest activity in your chnnel at 1500 when it's 2100 in
reality. So, you would set timefactor to +6. The other way round,
you would set timefactor to -6. 

trimlimit=1
After a time, the array holding the data gets spammed with dozens
of users counting only a few words (flyby's). They play only a
minor role for the CHATstats and would get deleted at 0600
(bot-time). Set to whatever or to 0 to disable this feature - 50
turned out to be a good value for medium-frequency channels. If you
set this variable to 0, you definitely should have a look at the
resources and the answer times of your bot. I've seen people in
high frequency channels setting this to 0 and wonder why their bot
was bogged and the database reached 20 MB.

adinterval=0
Want to advertize your website in the channel? Set this to the amount
of minutes after which CHATstats informs the chan about the website.
Set to 0 to disable.

adsite=http://www.yoursitehere.com
If adinterval is different from 0, set the website to be advertised
here (url only, no spaces!).

update=0
Defines if and after how many minutes the webpages get updated.
Setting this variable to 0 creates no webpage at all. This is needed
when the script shall be limited to IRC only.

htmsuffix=.htm
Set the suffix of the webpages.

ulmethod=0
Determine where the webpages shall go:
0 = do nothing, leave the webpages in $cs(workdir)
1 = move webpages to a local folder
2 = upload webpages via FTP

If ulmethod is 1, set the next variable (otherwise disregard):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
localfolder=/usr/home/bla/public_html/subdir/
Set to full path where the files should be moved to. Leave leading
and trailing /'s as shown.

If ulmethod is 2, set the next 5 variables (otherwise disregard):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ftpname=www.myftp.com
Set the name of the FTP server - do not include any subdirectories.

ftpport=21
Set the port of the FTP server (usually 21).

ftpfolder=/subdir/subdir/subdir/
Set the subdir, where the HTMLs should be FTP'ed to including leading
and trailing /'s as shown. Important: Set to nothing if not required.

username=username
password=password
Set username and password for the FTP given above (Note: for security
reasons, you should chmod 600 chatstats.tcl)
}

---------------------------------------------------------------------

Done. If that's OK for (all) your channel(s), stop here and read the
file 3_INSTALLATION.

If you need one or more different settings for one or more channels,
you need to insert the following into the script:

set cs(#channelname) {
setting1=value1
setting2=value2
..
}

Here you put all settings that are different from the global
config. Do not use uppercase letters for #yourchannel. E.g., if
#foobar's webpages need to be uploaded to a different server than
all other webpages (as given in cs(global)), you would do this:

set cs(#foobar) {
 ulmethod=2
 update=60
 ftpname=www.myotherftp.com
 ftpfolder=/mydir/
 username=username2
 password=password2
}

The webpages would get uploaded to www.myotherftp.com/mydir/
at a 60 minute interval. Note that the FTP port is 21 too,
so it doesn't need to be repeated. Don't forget the {brackets},
they're important! REMEMBER: Do this only for channels that
need _different_ settings as given in cs(global).