| HISTSTAT v2.00 Documentation
|
| Telegard HISTORY Statistics Message Generator
|
| Copyright 1992,1995 by Tim Strike and Forbidden Knights Systems.
| Released on July 12th, 1995.
____________
INTRODUCTION
____________
For use with Telegard 3.0. If used with any other versions of
TG, HISTSTAT could cause unpredictable and unrepairable results.
HISTSTAT was formerly ZLOGINFO. ZLOGINFO was a utility
written originally for Telegard 2.7. It started as a simple clone
of a statistics bulletin built into a VBBS system I once called
(1992). I thought the bulletin was interesting and handy, and thus
was built ZLOGINFO. Now three years later and a major upgrade in
Telegard, HISTSTAT has been released more configurable then ever
before.
Obviously this program isn't original in design - the output
is very similiar to that of VBBS, except we have the option of
colour, configurable fields and more options.
HISTSTAT works with the basis of templates; you design the
output colours and format that you want, and HISTSTAT fills in the
neccessary MCI codes with the correct statistical informaqtion,
compiled directly from your HISTORY.DAT file.
_________________
PROGRAM OPERATION
_________________
HISTSTAT <filename-of-HISTORY> <output> <template> <days>
<filename-of-HISTORY> is the full path and filename to the history
file that you want compiled. This will for most normal setups be
the /data/HISTORY.DAT file.
<output> is the filename to output. This should be a .MSG file
since you should likely use Telegard colour codes, but this isn't
neccessary. You should include the output PATH as well.
<template> is the full path and filename to the template file.
Template files define the output that will be sent to <output> so
it is a good idea to configure these in the way that you want --
SEE SECTION TITLED TEMPLATE FILES.
<days> is the number of days for which to compile the statistics.
If you set this parameter to a large number (i.e. 99999) then
HISTSTAT will compile the information for ALL days listed in your
history file. If you specify this to be a smaller number, say 30,
then HISTSTAT will compile the information for the last 30 days.
Sample command lines might be:
HISTSTAT \BBS\DATA\HISTORY.DAT \BBS\TEXT\LOGON.MSG TODAY.TPL 25
HISTSTAT \BBS\DATA\HISTORY.DAT \BBS\TEXT\BULL1.MSG AVGTOP.TPL 999
______________
TEMPLATE FILES
______________
Several sample template files have been provided with this version
of HISTSTAT. These template files may be freely used (they mimic
the output of the old ZLOGINFO program).
TODAY.TPL Statistics with Total & Today
TODAYTOP.TPL Statistics with Total, Today & Top
AVG.TPL Statistics with Total, Average & Today
AVGTOP.TPL Statistics with Total, Average, Today & Top
Please review these template files before you attempt to create
your own template files. To create your own template files you
will need a text editor and an understanding of the MCI codes that
are used in the file.
~ELnn Left-justify next MCI code in field of nn characters.
~ERnn Right-justify next MCI code in field of nn characters.
~ECnn Center next MCI code in field of nn characters.
And the statistical MCI codes:
%Act Calls NUsers Pub Email Net Errs UL DL ULk DLk
Average ~@A ~@B ~@C ~@D ~@E ~@F ~@G ~@H ~@I ~@J ~@K
Total ~#A ~#B ~#C ~#D ~#E ~#F ~#G ~#H ~#I ~#J ~#K
Top-num ~$A ~$B ~$C ~$D ~$E ~$F ~$G ~$H ~$I ~$J ~$K
Top-date ~%A ~%B ~%C ~%D ~%E ~%F ~%G ~%H ~%I ~%J ~%K
Top-perc ~&A ~&B ~&C ~&D ~&E ~&F ~&G ~&H ~&I ~&J ~&K
Top-graph ~^A ~^B ~^C ~^D ~^E ~^F ~^G ~^H ~^I ~^J ~^K
Today ~!A ~!B ~!C ~!D ~!E ~!F ~!G ~!H ~!I ~!J ~!K
Days ~)A
Total-perc/graph Total-perc/graph
Local ~(A ~*A 21600 ~(M ~*M
300 ~(B ~*B 24000 ~(N ~*N
1200 ~(C ~*C 26400 ~(O ~*O
1275 ~(D ~*D 28800 ~(P ~*P
2400 ~(E ~*E 38400 ~(Q ~*Q
4800 ~(F ~*F 57600 ~(R ~*R
7200 ~(G ~*G 64000 ~(S ~*S
9600 ~(H ~*H 115200 ~(T ~*T
12000 ~(I ~*I Other* ~([ ~*[
14400 ~(J ~*J
16800 ~(K ~*K
19200 ~(L ~*L
*Other -- the other speed graphs should be the LAST of the speed
statistics used (if you're going to use other statistics, then
they must comebefore ~([ and ~*[. The "OTHER" MCI codes will
contain anything that hasn't ALREADY been displayed -- so if
you leave some lessor used speeds out of your template file,
they will all be collected in the "OTHER" category. WARNING:
you should only use the speed MCI code once (i.e. you should
not use ~(K twice in the same template file.
All other text will be left as-is -- which means you can use
Telegard MCI codes in these template files as well. The output
file will have those MCI codes untranslated, so when Telegard
displays the bulletin, the MCI codes are translated properly.
This naturally also means that you can imbed colour codes without
question to spice up your bulletin in whatever fashion.
________
VERSIONS
________
This section will always contain the history/update information
on this program. It will list a general summary of bug fixes and new
features. Please read this section on every upgrade, even if you
don't plan on reading any other section.
+:New Feature *:Updated (Fixed) Feature
Prior to v2.00
+ Written in Turbo Pascal 6.0 for TELEGARD 2.7
+ Added AVERAGE statistics
+ Added TOP statistics
v2.00
+ Written in Turbo Pascal 7.0 for TELEGARD 3.0
+ Added template configuration removing need for all other
switches and adding the ability to change the output
colour and formats.
__________
LEGALITIES
__________
WARRANTY
HISTSTAT is provided as-is without a warranty of any kind,
either express or impled. This program is guarenteed to occupy
disk space and nothing more. Under no circumstances shall the
author or anyone related to the production of this utility be
liable to you or anyone else for any damages, including (but not
limited to) any lost profits, lost savings or other incidental
or consequential damages arising out of the use or misuse of
this program. Usage of this program is an understanding of said
statement.
In other words -- RUN THIS PROGRAM AT YOUR OWN RISK. By
choosing to use this program you are taking all responsibility
for anything that occurs with its usage.
COPYRIGHT
The program, and all documents and files included in the
original HISTSTAT release package are copyrighted to Tim Strike
and Forbidden Knights Systems. The included files may not be
modified in any manner.
The original archive may be freely distributed WITHOUT
charge. The format of the original archive can be changed to
another archiving product. At no point in the archives
distribution may files be added or removed.
HISTSTAT may be packaged on a distribution diskette or in a
compilation archive, but under no circumstances may any charge
be incurred beyond the physical cost of the hardware (disks,
CD...) or trasfer medium (phone, mail...).
CREDITS
All brand and product names referenced in this document are
trademarks, registered trademarks, or copyrighted works of
their respective holders.
_____________________
CONTACTING THE AUTHOR
_____________________
I can be contacted in a number of different methods. When
sending netmail or posting in one of the conferences, direct mail
to "Tim Strike". Replies will be forthcoming as soon as I can get
to them.
NETMAIL:
Telenet Canada Fidonet Xnet ITCnet
20:22/101 1:259/423 40:41/108 85:896/908
INTERNET:
ts@gryn.org
ECHOMAIL CONFERENCES:
TELEGARD Telegard Support (ITCNET)
TNC_FKNIGHTS Forbidden Knights Support (TNC)
TNC_TG Telegard Support (TNC)
TG_SUPPORT Telegard Support (FIDONET)
XNET_TG Telegard Support (XNET)
POSTAL MAIL:
Forbidden Knights Systems
Attn: Tim Strike
3360 Council Rind Rd, Unit 11
Mississauga, ON
L5L 2E4
BULLETIN BOARD:
Forbidden Knights Systems
(905)820-7273
2400-16,800 HST/v.32bis
Access denied between 4:00am and 5:00am
Restricted access between 10:00pm and 11:00pm
Any changes or upgrades that need to be made to HISTSTAT v2.00
will be made as time permits. Further suggestions, comments and/or
bug reports can be directed through one of the above methods.
Enjoy fully.