home *** CD-ROM | disk | FTP | other *** search
-
- ╒════════════════════════════════════════════════════════════════════╕
- │ ┌───────┐┌──────┐┌──────┐ ┌──────┐┌───────┐┌──────┐┌───────┐ │
- │ └───────┘└──────┘└──────┘ └──────┘└───────┘└──────┘└───────┘ │
- │ ┌─┐ ┌─┐ ┌─┐┌──────┐ ┌──────┐ ┌─┐ ┌──────┐ ┌─┐ │
- │ │ │ │ │ │ ││ ┌────┘ └────┐ │ │ │ │ ┌──┐ │ │ │ │
- │ │ │ │ └──┘ ││ │ ┌────┘ │ │ │ │ │ │ │ │ │ │
- │ └─┘ └──────┘└─┘ └──────┘ └─┘ └─┘ └─┘ └─┘ │
- ╘════════════════════════════════════════════════════════════ v0.45 ═╛
-
- A BBS Statistics Generator
- (c) Copyright 1994-1996 Dwayne Heaton
-
- ╒═══════════════════════════════════════════════════╕
- │ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Index ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ │
- ╞═══════════════════════════════════════════════════╡
- │ Introduction │
- │ What is TOPSTAT? 1.1 │
- │ System Hardware & software requirements 1.2 │
- │ Disclaimer and Licensing agreement 1.3 │
- │ Installation 2.0 │
- │ Usage │
- │ Command Line 3.1 │
- │ The TOPSTAT.CTL file 3.2 │
- │ The TOPSTAT.EXC file 3.3 │
- │ The TOPSTAT.SEC file 3.4 │
- │ Bug Reports and Contacting the Author 4.0 │
- │ Credits and Thanks 5.0 │
- └───────────────────────────────────────────────────┘
-
-
-
- ╒══════╤══════════════════════════════════════════════════════════════════════╕
- │ 1.1 │ What is TOPSTAT ? ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ │
- ╘══════╧══════════════════════════════════════════════════════════════════════╛
-
- TOPSTAT is a BBS statistics bulletin (ASCII/ANSi/AVATAR) generator.
- Currently it will produce a total of fourteen bulletins, ranging from
- downloaders to upcoming birthdays to message base statistics.
-
- Originally it was written just to display a few screens of the top
- uploaders, downloaders and callers to my system, but has expanded a little
- since then.
-
- It was designed to produce all it's bulletins as quickly as possible with
- as little configuration by the user as I could manage, while also allowing
- it to be as flexable as possible. I hope I've managed this.
-
- And Finally, the program is NOT crippled in any way whatsoever, and
- DOESN'T require any registration fees at all :-)
-
-
- ╒══════╤══════════════════════════════════════════════════════════════════════╕
- │ 1.2 │ System hardware and software requirements ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ │
- ╘══════╧══════════════════════════════════════════════════════════════════════╛
-
- * An IBM PC, XT, AT or 100% compatible PC with a hard disk.
- * Microsoft MS-DOS, IBM PC-DOS or DR-DOS version 3.30 or later. Version
- 5.0 or later is recommended.
- * At least 128KB of RAM available.
-
- * At the moment TOPSTAT only supports the following BBS user database:
- - Remote Access Copyright (c) Wantree Development & Andrew Milner
-
- * At The moment TOPSTAT only supports the following Message databases:
- - Hudson Copyright (c) Adam Hudson
- - JAM(mbp) Copyright (c) Joaquim Homrighausen, Andrew Milner,
- Mats Birch, Mats Wallin.
-
- * TOPSTAT has been successfully tested with MS-DOS 5.0, 6.0, 6.2 and
- 6.22, 4DOS 5.0 and 5.5, IBM OS/2 WARP, Novell Netware Lite v1.1,
- Novell Netware v3.12 on systems equiped with Intel/AMD 8086, 80286,
- 80386 and 80486 processors.
-
- * TOPSTAT has been successfully tested with the user base as used in
- Remote Access v2.00, v2.01, v2.02 and v2.50.
-
- * OS/2 is a registered trademark of IBM Corporation
- MS-DOS is a registered trademark of Microsoft Corporation
-
- All other programs are copyright and/or trademarked by their
- respective author unless otherwise noted.
-
-
- ╒══════╤══════════════════════════════════════════════════════════════════════╕
- │ 1.3 │ Disclaimer and Licensing Agreement ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ │
- ╘══════╧══════════════════════════════════════════════════════════════════════╛
-
- TOPSTAT consists of all files contained within the distribution archive.
- Before running TOPSTAT, you must read and agree to the following
- conditions. If you do not or can not agree to and accept the following
- conditions, you are prohibited from using TOPSTAT.
-
- ■ The documentation and accompanying program are copyrighted material
- designed, produced and tested by the author of the software.
-
- ■ TOPSTAT is distributed as FREEWARE *NOT* Public Domain!
-
- ■ Since this product is FREEWARE, you are actively encouraged to copy and
- distribute it as long as it remains in its complete form with all support
- and documentation files. No files may be added or taken away from the
- original archived form in which TOPSTAT is distributed.
-
- ■ Shareware vendors and BBSes may redistribute this product as long as they
- do not charge any money or monies for the product. Cost of distribution
- media (be it disk, CD-ROM, tape, etc) and/or subscription charges are
- acceptable.
-
- ■ I (Dwayne Heaton) am NOT oligated to provide new versions or support for
- TOPSTAT.
-
- ■ In the event that future versions of TOPSTAT are released, Dwayne Heaton
- reserves the right not to release them under the FREEWARE concept and to
- charge a nominal fee should it be deemed appropriate.
-
- ■ Although every care and attention has been taken to write and test the
- program to make sure that it does what this documentation states, the
- program is provided as it is, without warranty or guarantee of any kind,
- either expressed or implied, as to the quality or performance of this
- program, except that it will occupy disk space.
-
- ■ The author shall not be held liable to you or anyone else for any direct,
- indirect, incidental or consequential damages, including any lost profits,
- lost savings, lost business, which may result from the use or inability
- to use this program.
-
- ■ You are NOT allowed to do any disassembling, reverse engineering, creating
- patches for TOPSTAT and things alike.
-
- ■ Your use of this program constitutes your agreement to this disclaimer and
- your release of the author from any form of liability or litigation.
-
- ■ The source code or part of it, is NOT available.
-
- ■ All rights reserved worldwide.
-
-
- ╒══════╤══════════════════════════════════════════════════════════════════════╕
- │ 2.0 │ Installation ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ │
- ╘══════╧══════════════════════════════════════════════════════════════════════╛
-
- Making use of TOPSTAT couldn't be much easier! Unpack all the files
- in the archive into one directory.
-
- A new feature of TOPSTAT (as from v0.37) is the ability to configure the
- program to suit your system.
-
- The config file ('TOPSTAT.CTL') must be in the same directory that you are
- running TOPSTAT from. It doesn't have to exist, but if you want greater
- control over the program, it should (since it gives you more options than
- the command line). The control (config) file is explained in more detail
- in section 3.2, 'The TOPSTAT.CTL file'
-
- TopStat will also allow you to exclude specific users from the bulletins.
- The file to allow this is explained in more detail in section 3.3, 'The
- TOPSTAT.EXC file'
-
- You will need to have the RA environment variable set, so that it points
- to your Remote Access system directory, but if you are running RA without
- any problems, this should be already be set :)
-
- Once you have installed TOPSTAT, you are ready to produce your bulletins.
- The bulletins will be placed in the main Text Files directory as specified
- in your Remote Access configuration file.
-
- You could run it after every call to the BBS, or you could run it in any
- daily maintenance events.
-
-
- NOTE - TOPSTAT will try and use SHARE to open all files it needs. This
- will allow multi-line BBS's to run it without having to take all
- the nodes down first (sorry 'bout that folks).
-
-
- ╒══════╤══════════════════════════════════════════════════════════════════════╕
- │ 3.1 │ Command Line ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ │
- ╘══════╧══════════════════════════════════════════════════════════════════════╛
-
- There are a few command-line options you can use for greater control over
- the program's operation.
-
- If you do not specify any options TOPSTAT will use its internal defaults
- of excluding the SYSOP, including HIDDEN users, excluding GUEST accounts,
- generating ASCII and ANSi screens, using users real names and using full
- colour for its screens while running.
-
-
- TOPSTAT -? Shows a brief help screen with all options listed
- on it.
-
- -HELP Same as above.
-
- -SYSOP This will force TOPSTAT to include the Sysop in
- the bulletins. The Sysop will still be excluded if
- they are a 'hidden' user, and the '-HIDDEN' option
- is not specified.
-
- -NOHIDDEN This will tell TOPSTAT to exclude any user that
- has been set as 'hidden'
- (A hidden user is one that has the 'exclude from
- user list' flag set in their user record)
-
- -GUEST This will tell TOPSTAT to include any user that
- has been set as 'guest'
- (A guest user is one that has the 'guest account'
- flag set in their user record)
-
- -HANDLE This will make TOPSTAT use the user's handle
- instead of their real name. (If there is no
- handle set, it will use the real name instead)
-
- -NOASCII Stops TOPSTAT producing the ASCII bulletins
-
- -NOANSI Stops TOPSTAT producing the ANSi bulletins
-
- -NOBDAY Stops TOPSTAT from generating the 'Upcoming
- Birthdays' bulletin.
-
- -NOMSGB Stops TOPSTAT from generating the 'Most
- Active Message Areas' bulletin.
-
-
- TOPSTAT produces at the moment a total of fourteen bulletins. The default
- filenames and a small description of each bulletin follow. They are placed
- in the main textfiles directory, as specified in your RemoteAccess config
- file.
-
-
- ╒══════╤══════════════════════════════════════════════════════════════════════╕
- │ 3.2 │ The TOPSTAT.CTL file ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ │
- ╘══════╧══════════════════════════════════════════════════════════════════════╛
-
- As said before the control (config) file will allow you to fully configure
- TOPSTAT to your system. It will allow you to set all the options that the
- command line does, but with has several more options.
-
- If this is a new installation just run SETUP.EXE to create an initial
- TOPSTAT.CTL file with default settings.
-
- If this is an upgrade installation, run SETUP.EXE to update your existing
- TOPSTAT.CTL with any new options. Follow the on screen information.
-
- The options can be in any order, and any line starting with a ';' is
- counted as a comment line and isn't processed.
-
- Here is a list of options you can use, and a description of what they do.
-
- General Settings
- ----------------
- BBSSoftware Version of RemoteAccess you are running.
- IncludeSysop Whether to include the Sysop in the output, or not.
- (Even if he/she is a hidden user)
- IncludeHidden Include users marked as hidden in the output.
- IncludeGuest Include GUEST users in the output.
- UseHandles Use user-handles instead of their real names.
- ASCII Produce an ASCII output file.
- ANSi Produce an ANSi output file.
- AVATAR Produce an AVATAR output file.
- EnterPrompt Add the RemoteAccess 'Wait for Enter' control code.
- BirthdayCount The number of days to include for Upcoming Birthdays
-
- BBSSoftware accepts the following values : RA20x, RA250
-
- IncludeSysop, IncludeHidden, UseHandles, ASCII, ANSi, AVATAR and
- EnterPrompt accept the following values : Yes or No, On or Off, True
- or False
-
- BirthdayCount accepts an integer in the range 1 to 366.
-
- Colour Settings
- ---------------
- Main.Title The colour of the Bulletin Title (used in all the
- available bulletins)
- Main.Border The colour of the border (used in all the available
- bulletins)
- General.Name The colour of the Username (or handle) , as used in
- the non-graph bulletins.
- General.Value The colour of the value (Files, KB, etc) as used in
- the non-graph bulletins.
- Graph.Desc The colour of the description of the range (only
- used in the graph bulletins)
- Graph.Count The colour of the count in the graph bulletins
- Graph.Bar The colour of the Bar in the graph bulletins
- Graph.Percent The colour of the percentage
- BDay.Name The colour of the username in the birthdays bulletin
- BDay.Age The colour of the age in the birthdays bulletin
- BDay.DOB The colour of the birthdate in the birthdays bulletin
-
- ╓─────────────────── Table of valid names and numbers ────────────────────╖
- ╠════╤══════════╗╔════╤══════════════╗╔════╤════════════╗╔════╤═══════════╣
- ║ 0 │ Black ║║ 1 │ Blue ║║ 2 │ Green ║║ 3 │ Cyan ║
- ║ 4 │ Red ║║ 5 │ Magenta ║║ 6 │ Brown ║║ 7 │ LightGray ║
- ║ 8 │ DarkGray ║║ 9 │ LightBlue ║║ 10 │ LightGreen ║║ 11 │ LightCyan ║
- ║ 12 │ LightRed ║║ 13 │ LightMagenta ║║ 14 │ Yellow ║║ 15 │ White ║
- ╠════╧══════════╝╚════╧══════════════╝╚════╧════════════╝╚════╧═══════════╣
- ╙─────────────────────────────────────────────────────────────────────────╜
-
- Filename Settings - Each has either a ASC, ANS or AVT preceding them. The
- ASC is used for the ASCII bulletin filename, while the
- ANS is the ANSi bulletin's filename and the AVT is the
- AVATAR bulletin's filename. The specific bulletin
- can be disabled if you specify No or Off or False as
- the filename.
-
- A??_Callers Top Callers bulletin
- A??_Download_File Top Downloaders (in Files) bulletin
- A??_Download_KB Top Downloaders (in KB) bulletin
- A??_LongAgo How long Ago (Did they call) bulletin
- A??_Message Top Message Writers bulletin
- A??_TimesCalled Number of times Called bulletin
- A??_UpLoad_File Top Uploaders (in Files) bulletin
- A??_UpLoad_KB Top Uploaders (in KB) bulletin
- A??_UserAges User Age Statistics bulletin
- A??_SecLevels Security Levels Statistics bulletin
- A??_MaleFemale Male / Female Statistics bulletin
- A??_Settings The User Settings Report
- A??_Birthdays The Upcoming Birthdays bulletin
- A??_MsgBase The Most Active Message Areas bulletin
-
-
- ╒══════╤══════════════════════════════════════════════════════════════════════╕
- │ 3.3 │ The TOPSTAT.EXC file ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ │
- ╘══════╧══════════════════════════════════════════════════════════════════════╛
-
- TopStat is able to use an external file of users to exclude. It will use
- this list to filter out the users listed from ALL of the bulletins. The
- name file must be named TOPSTAT.EXC and must be located in the TopStat
- system directory (The directory you run TopStat from.)
-
- Currently TopStat will only use the first 25 users in the exclude list.
-
- The file _MUST_ contain only one user per line. The name must have the
- spaces between first name and surname must be replaced with an underscore
- (_). TopStat isn't case-sensitive.
-
- A sample Exclude file may look like this:
- ----------------------------
- Dwayne_Heaton
- Joaquim_Homrighausen
- Andrew_Milner
- Mats_Birch
- Mats_Wallin
- ----------------------------
-
-
- ╒══════╤══════════════════════════════════════════════════════════════════════╕
- │ 3.4 │ The TOPSTAT.SEC file ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ │
- ╘══════╧══════════════════════════════════════════════════════════════════════╛
-
- TopStat is able to use an external which describes your security levels,
- which if it exists will be used to build up the Security Levels bulletin.
- The name file must be named TOPSTAT.SEC and must be located in the TopStat
- system directory (The directory you run TopStat from.)
-
- Currently TopStat will only use the first 25 levels in the list.
-
- The format of each line in the file is as follows.
-
- Level, Description, Time Limit and Download Limit
-
- The file _MUST_ contain only one user per line. The name must have the
- spaces between first name and surname must be replaced with an underscore
- (_). There needs to be a minimum of one space between each field (level,
- description, time limit and download limit). TopStat isn't case-sensitive.
-
- A sample Exclude file may look like this:
- ----------------------------
- ;
- ; Level Description Time Limit Download Limit
- ;
- 0 Locked_Out_User 0 0
- 8 Un-Registered_User 30 500
- 16 Registered_User 60 1250
- 32 Enhanced_User 75 2000
- 64 Super_User 90 2750
- 128 Vising_Sysop 120 5000
-
-
- Any securoty levels that you don't include in the TOPSTAT.SEC file will
- be displayed on the bulletin as 'Unlisted Security Levels' with a count
- and a percentage.
-
-
- ╒══════╤══════════════════════════════════════════════════════════════════════╕
- │ 4.0 │ Bug Reports and Contacting the Author ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ │
- ╘══════╧══════════════════════════════════════════════════════════════════════╛
-
- Please contact me if you have any bug reports and/or suggestions for
- improvements to TopStat.
-
- If you have a bug report, fill in the REPORT.BUG file that should have
- been included in the distribution archive, rename the file to your boards
- name (or first 8 characters :) [Please keep the extension of .BUG]
- and mail it to me at one of the addresses below.
-
- I'm open to suggestions for support for other BBS software. If you wish
- this please supply the structure of the userbase (and all related files)
- files (PASCAL is prefered, but I can work with C) of the BBS software
- you wish supported (Also, could you give me a list of environment
- variables it uses, and what they point to, ie RA points to the Remote
- Access system directory, and the CONFIG.RA data file). I cannot guarantee
- it will be supported in future versions (if any), but you never know.
-
- I can be contacted using a number of different methods:
-
- Page/Leave a message on my BBS:
- Virtual Maddness -- +44-1344-422575 -- 24 hours, 1200 to 28800 baud
-
- Send a netmail to me at one of my various AKAs:
- FidoNet : 2:252/314
- RANet : 73:7441/13
- PascalNet : 115:4401/407
- Internet : dwayne@vmadd.demon.co.uk
- dwayne@roan.co.uk
-
-
- ╒══════╤══════════════════════════════════════════════════════════════════════╕
- │ 5.0 │ Credits and Thanks ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ │
- ╘══════╧══════════════════════════════════════════════════════════════════════╛
-
- Thanks to my beta testers for helping me test my progs and for their
- numerous suggestions, helpful criticism and for the multitude of
- bug reports.
-
- Thanks to Peter Burnett for supplying various bits of source code.
-
- Also thanks must go out to all the people who have sent suggestions
- to me (Please keep it up), no names since you know who you are (actually
- the list is too large to be included here)
-
-
- Beta Testers
- ============
-
- Andrew Thomas Andy's Bulletin Board! +44-161-343-4730
- FidoNet 2:250/176
- RANet 73:7446/15
-
- Dean Rocks The Happy Hippy BBs +44-1325-354105
- FidoNet 2:256/602
- RANet 73:7447/602
-
- Steven Holme The Fonty Towers BBS +44-115-952-7443
- FidoNet 2:2503/216 +44-115-955-4440
- 2:2503/226
- RANet 73:7444/22
-
- Peter Burnett Neverland eXpress +44-1424-853361
- FidoNet 2:441/80
- RANet 73:7441/206
-
- Michael Devonport Midnite Madness BBS +44-181-287-5901
- FidoNet 2:254/301
- RANet 73:7441/15
-
- Simon Cansick Guru-Ten BBS +44-1535-691734
- FidoNet 2:250/364 +44-1535-691735
- 2:250/365
- RANet 73:7448/13
-
-
- ╒═════════════════════════════════════════════════════════════════════════════╕
- │ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ End of File TOPSTAT.DOC ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ │
- ╘═════════════════════════════════════════════════════════════════════════════╛
-
-