home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 2 BBS
/
02-BBS.zip
/
TMS115.ZIP
/
TMSTAT.DOC
< prev
next >
Wrap
Text File
|
1991-04-03
|
28KB
|
810 lines
╔══╗ ╔══╗
║ ┌────────────────────────────────────────────────────────║┐ ║
╚══╝ ███████░ ███████░ ███████░ ███████░ █████░ ███████░ ╚│═╝
│ ▐██░ ██░█░██░ ██░ ▐██░ ██░ ██░ ▐██░ │
│ ▐██░ ██░█░██░ ███████░ ▐██░ ███████░ ▐██░ │
│ ▐██░ ██░ ██░ ██░ ▐██░ ██░ ██░ ▐██░ │
╔═│╗ ▐██░ ██░ ██░ ███████░ ▐██░ ██░ ██░ ▐██░ ╔══╗
║ └║────────────────────────────────────────────────────────┘ ║
╚══╝ For OS/2 and DOS - Maximus-CBCS v1.02 ╚══╝
TMSTAT
"The MANiAk Statistics"
Version 1.15
Saturday 6 April 1991
(C) Copyright 1990-1991 by Emmanuel SANDORFI
=============================================================================
INTRODUCTION:
-------------
TMSTAT is a statistics maker for Maximus systems, OS/2 or DOS. It is
developped in C/2 under OS/2, and BINDed to make it available for all
poor DOS sysops.
It can create a lot of different things:
■ a Today's Callers report file
■ a Top Callers... ─┐ with nice graphical report, ascii or
■ a Top Downloaders... ├ avatar, with automatical pourcentage
■ a Top Uploaders... ─┘ bars.
■ an Userlist generation with configurable data fields for level
But just continue to read this documentation to have more
informations on TMSTAT.
Remark.. As my english is not very famous, please, don't be so rude with
the horrors in the english writing of this document.
WARRANTY:
---------
TMSTAT, the Statistics program for Maximus developped by E. SANDORFI,
is released to the PUBLIC DOMAIN as a FREEWARE.
This program is guaranteed to do absolutely nothing. Use it at
your own risk. No warranty is stated or implied. The author shall
not be responsible for any damages resulting from it's use, directly
or indirectly.
CONFIG FILE:
------------
TMSTAT is a powerfull tools with his configuration file as you can do
and changes a lot of thing.
BTW, there is the Default Values:
╔═════════════════════╦════════════════════════════╗
║ CONFIG OPTIONS ║ DEFAULT VALUES ║
╠═════════════════════╬════════════════════════════╣
║ Config File ║ Tmstat.Cfg ║
║ TCR Date ║ Today's date ║
║ Graphic % Base ║ Higher value in user.bbs ║
║ All Colors ║ Gray ║
║ Work Mode ║ Verbose ║
║ AutoFail Mode ║ Off ║
║ BBS Name ║ Your BBS... ║
║ Frenchy Mode ║ Off ║
║ NoCls ║ Off ║
║ NoEnterKey ║ Off ║
║ UserBase ║ User.Bbs ║
║ TOP_CallTXT ║ TopCalls.Txt ║
║ TOP_CallBBS ║ TopCalls.Bbs ║
║ TOP_DnldTXT ║ TopDnlds.Txt ║
║ TOP_DnldBBS ║ TopDnlds.Bbs ║
║ TOP_UpldTXT ║ TopUplds.Txt ║
║ TOP_UpldBBS ║ TopUpld.Bbs ║
║ TOP_CallNb ║ 25 ║
║ TOP_DnldNb ║ 25 ║
║ TOP_UpldNb ║ 25 ║
║ TOP_P100Char1 ║ ▒ ║
║ TOP_P100Char2 ║ ░ ║
║ TCR_RptTXT ║ Callers.Txt ║
║ TCR_RptBBS ║ Callers.Bbs ║
║ USRFile ║ UsrFile.Txt ║
╚═════════════════════╩════════════════════════════╝
Configuration Keywords Definition:
<GB>... Global Options
<TC>... Today's Callers Options
<TO>... TOP Users Options
<US>... Userlist Options
<GB> Autofail
As TMSTAT have a little VIO interface, after each critical
error, you have to press the Enter key to continue (like the
bad Trap Errors of OS/2). With this option on, you won't
have to press enter after an error to exit.. But be care, you
won't be able to see the error message too!
<GB> BBSName <name>
Give the name of your Board which appeared in all report files.
<GB> French_Report
TMSTAT could create special frenchies report files (TOP & TCR).
If you want to have those nicely files, don't comment this
option. Otherwise, you will get default screens in english.
<GB> NoCls
Use this option if you don't want a CLS character at the
begining of any report files.
<GB> NoEnterKey
Use this option only if you don't want a 'Press Enter to
Continue' after displayed the report file. This is only
for the avatar screens displayed by Maximus itself.
<GB> Quiet
If you want to run TMSTAT in a quiet mode, without many
informations. This disable the VIO interface of Tmstat itou.
<GB> UserBase <filename>
Path and filename of your user base at Maximus-CBCS 1.02
format (only!). If you don't specify the <filename>, TMSTAT
will search for 'user.bbs' in your current path by default.
<TC> TCR_Okay
Start the TCR section when you launch TMSTAT without
arguments..
<TC> TCR_Color(1) <color> ... TCR_Color(14) <color>
See TOP_Color(n) option for more informations, and the
config file for the reference..
<TC> TCR_RptBBS <filename>
..If you want to create a Today's Callers file in avatar
format (Maximus file, like mecca tokens compiled).
By default, TMSTAT create 'CALLERS.BBS' For more infos,
read the TOP_CallTXT description.
<TC> TCR_RptTXT <filename>
..If you want to create a Today's Callers file in ascii
format. By default, TMSTAT create the file 'CALLERS.TXT'
For more help, read the TOP_CallTXT description.
<TO> TOP_CallBBS <filename>
..If you want to create a Top Callers file in avatar format
(Maximus file, like mecca tokens compiled).
By default, TMSTAT create 'TOPCALLS.BBS' For more infos,
read the TOP_CallTXT description.
<TO> TOP_CallNb <value> Maximum Range: 1 to 999
You can choose by this option how many users you want to
see in yours Top Callers files.. You may create a
Top 10 Callers, but if you prefer, create a Top 50 Callers
or anything else. You have just to put the number of users
you want to be in the Top screens after this option.
<TO> TOP_CallP100 <value>
In all the top xx screens, there are a graphic pourcentage
by user. It is normally the number of user calls by the
total calls (or downloads, or uploads). The problem is
generally the total number grown faster than the user number
and that give you a real little number (or a too big if there
isn't a big activitie on your board). In all the case, it
can't be a proportionnal number, and that's difficult to
represent it in a graphic mode.
So, the idea is because the total number grown fast, faster..
keep it away and take our own proportionnal number. With this
attitude, we could get a graphic poucentage pretty
consistency and not with valors like 0.017, YOU put your own
pourcent base. For example, if the users of Top 10 Callers
don't get much than 200 calls but your total calls is 10.000,
well.. ( 200 / 10 000 ) * 100 = 2 %
Okay, now put this pourcentage in ansi graphic in 10
characters maximum (0 to 100 % ).
Now, you put in this config file the option TOP_CallP100 300
(or 200 if you prefer), you will get a pourcentage of 66 %,
and it's really easier to reprensent 66 % in 10 characters
than 2 % !!
<TO> TOP_Calls_Okay
This is the same thing that TOP_Okay but just created the
Top Callers screen and not all the 3 TOP files. But you may
have specifical TOP_xxxx_Okay keywords if you want, for sample,
a TOP Callers and a TOP Downloaders, no TOP Uploaders. It
will look like..
%% TOP_Okay %% Don't make all the TOP xxxx files
TOP_Calls_Okay %% Make the TOP Callers
TOP_Dnlds_Okay %% ..and the TOP Downloaders
%% TOP_Uplds_Okay %% ..but not the TOP Uploaders.
<TO> TOP_CallTXT <filename>
When you create the Top Callers screen (by putting TOP_Okay
or TOP_Calls_Okay or by command line argument), you can get
2 different sorts of Report file: One in Ascii format (i.e.
for your beautiful sysop's eyes) and One in Avatar format (
to be displayed by Maximus).
This option allow you to create the Ascii file. If you don't
want an ascii file, just comment it. If you don't specify a
<filename>, TMSTAT will create by default the file
'TOPCALLS.TXT' (always in the current directory of course)
note: The option format for the ascii file is TOP_aaaaTXT
..avatar file is TOP_aaaaBBS
<TO> TOP_Color(1) <color> ... TOP_Color(16) <color>
You configure all the colors (only avalaible in the avatar
file, .BBS) of the top screens. If you don't specify the
<color>, it will be GRAY by default.
The <color> availables are:
Dark Blue Green
Cyan Red Magenta Gray
LightGray LightBlue LightGreen LightCyan
LightRed LightMagenta Yellow White
See the config file about the reference for TOP_Color(n)
<TO> TOP_DnldBBS <filename>
..If you want to create a Top Downloaders file in avatar
format (Maximus file, like mecca tokens compiled).
By default, TMSTAT create 'TOPDNLDS.BBS' For more infos,
read the TOP_CallTXT description.
<TO> TOP_DnldNb <value> Maximum Range: 1 to 999
Idem that TOP_CallNb but for the Top Downloaders screens..
<TO> TOP_DnldP100 <value>
Idem that TOPCallP100 but for the Top Downloaders screens..
<TO> TOP_Dnlds_Okay
Make the TOP Downloaders automatically.
<TO> TOP_DnldTXT <filename>
..If you want to create a Top Downloaders file in ascii
format. By default, TMSTAT create the file 'TOPDNLDS.TXT'
For more help, read the TOP_CallTXT description.
<TO> TOP_Okay
You could run TMSTAT in unattended mode by this option (and
also with all the different xxx_Okay options). All the TOP
files will be created automatically by using this keyword when
you'll start TMSTAT without any arguments. You will got
a Top Callers, a Top Downloaders and a Top Uploaders report
files. (You may add the TCR_Okay and the USRList_Okay and it
will do the same thing as you start TMSTAT with the ALL keyword)
<TO> TOP_P100byTMS
[BUT..] You could oblige TMSTAT to do himself this job for
create a good graphic pourcentage - so for don't use the
options 'TOP_XxxxP100 <value>' . With this option, TMSTAT
will check for the higher value of calls, downloads or/and
uploads kilobytes in your user.bbs, and take this value for
the pourcenta base.
<TO> TOP_P100Char1 <c>
To make the representation of the pourcentage more agreable
to see, TMSTAT switch in a base of 2 different graph and
color. Of course, if you don't want that, you can put the
same character (and color) in those 2 options (TOP_P100Char1
and TOP_P100Char2). Don't forget that a CHARACTER and only
a character is needed for this option.
<TO> TOP_P100Char2 <c>
The second character for the representation of the graphic
pourcentage.
<TO> TOP_UpldBBS <filename>
..If you want to create a Top Uploaders file in avatar
format (Maximus file, like mecca tokens compiled).
By default, TMSTAT create 'TOPUPLDS.BBS' For more infos,
read the TOP_CallTXT description.
<TO> TOP_UpldNb <value> Maximum Range: 1 to 999
Idem that TOP_CallNb but for the Top Uploaders screens..
<TO> TOP_UpldP100 <value>
Idem that TOPCallP100 but for the Top Uploaders screens..
<TO> TOP_Uplds_Okay
Make the TOP Uploaders automatically.
<TO> TOP_UpldTXT <filename>
..If you want to create a Top Uploaders file in ascii
format. By default, TMSTAT create the file 'TOPUPLDS.TXT'
For more help, read the TOP_CallTXT description.
<US> USRFile <filename>
Specify the userlist filename. By default, it is 'USRLIST.TXT'.
<US> USRList_Okay
Start atuomatically the generation af an userlist.
See the chapter 'A Word about Userlist' for more infos.
<US> USRPriv <level> <data>
The userlist generated have a level field. With this option,
you can translate the privilege name in what you want.
Levels allowed are: Twit, Disgrace, Limited, Normal, Worthy,
Privil, Favored, Extra, Clerk, AsstSysop,
Sysop and Hidden.
Sample: USRPriv Twit Bad Baddy Guy
So, all twit users will got the 'Bad Baddy Guy'
attribution after their name.
Total Options: 65
COMMAND LINE OPTIONS:
---------------------
TMSTAT could run with or without arguments.
Global Options KeyWords KeyW. Options
--------------------------------- --------- -------------
TMSTAT (-U<user> -C<config> -V -Q -? -H) [TCR] (......)
[TOPUSER] (......)
[USRLIST] (......)
[ALL]
[ERROR]
[HELP]
NOTE: All the options OVERWRITE the data configured in the config file.
If you have specify an xxx_Okay option in this file, you may start
TMSTAT without any arguments.
* Global Options:
-U<userbase> Give to TMSTAT a special user base at Maximus
format.
-C<configfile> Read another config file than tmstat.cfg
-V Works in VERBOSE mode
-Q Works in QUIET mode
-? (-H) Display an Help Screen
The global options works in every case and are independant of the
KEYWORD you used.
* KeyWords:
TCR Start the Today's Callers report section.
TOPUSER Start the Top Callers/Downloaders/Uploaders sect.
USRLIST Generate an userlist based on your userbase.
ALL Start ALL the different sections.
ERROR Give some help about TMSTAT errors.
HELP Give some help about the different keywords.
* TCR Options:
-B<callers.bbs> Create a Today's Callers Report file in AVATAR
format, which could be display by Maximus with
a command like Display_File or [display]
-T<callers.txt> Create one but in ASCII format
-D<date> Give another date than the today's date to TMSTAT
to create a report with the callers of <date>
which haven't been connected on the BBS after.
BE CARE of the format !
You must specify a date by dd-mm-yyyy or if
your code country is configured for the USA,
mm-dd-yyyy
i.e. for Europe
TMSTAT ... TCR -d01-01-1991 : 1 Jan 91
TMSTAT ... TCR -d25-12-1990 : 25 Dev 90
TMSTAT ... TCR -d10-02-1989 : 10 Feb 89
-? (-H) Give you some helps about the TCR options
i.e. about using the TCR options
TMSTAT TCR
Start the TCR section (ONLY)
TMSTAT -ue:\max\user.bbs TCR
Idem that the first example, but read the user base
e:\max\user.bbs
TMSTAT -q TCR -t15Jan90.txt -d15-01-1990
Start the TCR section (ONLY) in Verbose mode, create a report
file in ascii only '15Jan91.Txt' for the callers of 15 January
1990 which haven't called after
* TOPUSER Options:
-CALL
-DNLD If you want to parse command line arguments in
-UPLD the TOPUSER section, you will need to specify what
sort of work you want to create the..
Top Callers, (-CALL)
Top Downloaders, (-DNLD)
Top Uploaders. (-UPLD)
You can't specify more than one -KEY and you MUST
give one.
-B<report.bbs> Create an AVATAR report file (for Maximus). This
file will be a top calls|uploads|downloads screen
according to the -KEY you have choosed.
-T<report.txt> Idem but in ASCII format.
-N<xx> You can create a Top xx Callers|Dnlders|Uplders..
Just give an integer value between 1 and 999.
-? (-H) Give you some helps about the TOPUSER options
i.e. about using the TOPUSER options
TMSTAT TOPUSER
Start the TOPUSER section (ONLY) and create all the Tops if you
have specified in the config file some TOP_XxxxOkay options..
TMSTAT TOPUSER -tDownloads.Txt -n100
Create the TOP 100 Downloaders in an ascii file only called
downloads.txt
* USRLIST Options:
-T<userlist> Specify the another name for the user list than
default one, USRLIST.TXT.
With the config file, you can select exactly what you do by this commands
BUT it have the advantage to drop all those commands..
i.e. TMSTAT
Will create all the Top screens if you have specified TOP_Okay
in your config file. Report you to this file to have more infos
about that.
A WORD ABOUT THE TCR SECTION:
-----------------------------
The Today's Callers Report (TCR) is made from the file USER.BBS of
Maximus where it compares the users last date with the today date to
create a file with all the users who have been connected today.
It doesn't look in the files LASTUSER.BBS.
A WORD ABOUT THE USERLIST SECTION:
---------------------------------
This option of TMSTAT is a Quick'n'Dirty like. <ohps>
It doesn't allow a lot of modifications.. Just the level data translation.
The userlist generated will have those fields:
[user_id] [user_name] [last_cnx] [level_data] [city] [calls] [dnld] [upld]
And that's all!
HOW TO JOIN THE AUTHOR:
-----------------------
If you want to send me your suggestions, whishes, or remarks about
TMSTAT, you can reach me at:
FIDOnet: 2:320/5 BBS: +33 1- 64.09.04.60 HST v42bis
+33 1- 64.09.06.63 2400 MNP
MAIL address: Emmanuel SANDORFI
13, Rue Jehan de Brie
77000 - Melun
FRANCE
If you send me some bug reports, don't forget to send me a little
note which explain how it happened and also the report files if there
is any..
HISTORY:
--------
Version 1.15 - 06 April 91 ==================================================
+ Third public release of TMSTAT. It will be normally the _last_ fapi
version (running on the both environment, OS/2 and DOS) if no new bugs
appeared.
Next release will be PM based and will be a part of a powerfull toolbox
for all OS/2 Maximus sysops under PM..
Version 1.12c - 29 Mars 91 ==================================================
+ Optimize the parsing session for the config file and the options.
+ Add an UserList session to make a list of all users. (Quick Section)
This feature create an ascii list of all your users following this format:
* UserName [Date/Time Last Connexion] Privilege_Data
New config options are:
USRList_Okay Create a userlist
USRFile <filename> Userlist filename (default: USRList.Txt)
USRPriv <priv> <data> Translation of the Maximus privilege in what you
want..
i.e. USRPriv Normal Happy User & Regular.
<priv> could be:
Twit, Disgrace, Limited,
Normal, Worthy, Privil,
Favored, Extra, Clerk,
AsstSysop, Sysop or Hidden.
<data> could be really what you want. (bis)
Don't wait something wonderfull from this option, it was just done for
a little need of my system.
Version 1.12b - 27 Mars 91 ==================================================
+ Fix a little VIO pb with the cursor after runnig TMStat.
+ Add the option 'AutoFail' in the config file. With this, you wouldn't have
to press the enter key when an error happened.
Version 1.12a - 09 Mars 91 ==================================================
+ Fix the March Bug.. where any callers were reported in the TCR file.
Why? Because there was a little mistake in the definition of the months.
Yes, March was considered as the 4th month of the year, and April as the
3th. Really sorry.
+ Display now the BBS Name, the TOP xx and the Creation Date/Time on each
TOP' headers.
+ Fix the TOP high value users which doesn't appeared in the reports files.
+ Fix a sort problem in the TOPs files..
Version 1.11b - 14 January 91 ================================================
+ Display when Verbose mode is selectionned the current language for the RFs
and the bbsname
+ Two languages are now available in the report files (TCR & TOPs):
the French by the option French_Report (config file) and the English by
English_Report. note: English is the default language
i.e. French_Report
(now have an easy possibility to add any languages for the Report Files,
just ask..)
+ Fix a bug when quiet mode was selectionned and when you got an error or
an help screen before having user base informations. (pb in the VIO status
bar)
+ Add the status word HELP when TMSTAT give you some helps, and the word ERR!
when there is an error
+ Trunc all error msgs when they're more than 58 characters to have always
a good dialog error box..
+ Fix a bug (appeared in the 1.11a) which occured a trap error when
you give an unknown keyword at the cmd line
+ Add the config option BBSName <name> in the config file to put your BBS
name in the reports file. Maximum characters of the <name>: 30 If there
isn't a name specified, TMSTAT will take the string 'YOUR BBS..'
i.e. BBSName OS/2 MANiA
Version 1.11a - 07 January 91 ================================================
+ A new & complete VIO interface was added JUST FOR THE FUN..!! There is now:
- A Status bar which informs you of the progress made by TMSTAT
- Help & Error dialog boxes
- Colorfull display informations..
- Some extra scrolling with the TCR data
- Look yourself for the rest of adds!
+ Fix the bug of (sometimes) double user in the Today's callers files
+ Check before starting anything if the user file isn't corrupted, at Maximus
1.02 format (Error 5)
Version 1.10 - 03 January 91 =================================================
+ Major Changes with the Add of all TOP's report files (Top Uploaders,
Downloaders, Callers).
+ Revision of the command parsing, etc..
Version 1.00 - 15 October 90 =================================================
+ First Shoot.. TMSTAT is now a Public Release.
End of TMSTAT Documentation