Beijing Paradise BBS Backup

home *** CD-ROM | disk | FTP | other *** search

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / TSTAT047.ZIP / TOPSTAT.DOC < prev next >

Wrap

Text File | 1996-05-28 | 18.7 KB | 437 lines

┌─ │ ┌───────┐┌──────┐┌──────┐┌──────┐┌───────┐┌──────┐┌───────┐ │ └───────┘└──────┘└──────┘└──────┘└───────┘└──────┘└───────┘ │ ┌─┐ ┌─┐ ┌─┐┌──────┐┌──────┐ ┌─┐ ┌──────┐ ┌─┐ │ │ │ │ │ │ ││ ┌────┘└────┐ │ │ │ │ ┌──┐ │ │ │ │ │ │ │ └──┘ ││ │ ┌────┘ │ │ │ │ │ │ │ │ │ │ └─┘ └──────┘└─┘ └──────┘ └─┘ └─┘ └─┘ └─┘ └──────────────────────────────────────────────────────── v0.47 ─ A BBS Statistics Generator Copyright (c) 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 RemoteAccess BBS Statistics generator. It currently produces a total of fifteen bulletins, ranging from top downloaders to upcoming user birthdays to message base statistics. It will produce ASCII, ANSi and AVATAR bulletins. TopStat was originally written just to display a few screens of the top uploaders, downloaders and callers to my BBS. It has expanded a little since then, due to requests for extra bulletins to be generated. TopStat is designed to produce the bulletins as quickly as is possible with as little configuring by the sysop, while also allowing it to be flexable. I hope this has been achieved. TopStat is not crippled in any way what-so-ever, and it does not require any registration fees to be send in to use it. ┌─ │ 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, Windows 3.1, Windows for Workgroups 3.11 and Windows 95, Novell Netware Lite v1.1, Novell Netware v3.12 on systems equiped with Intel/AMD 8086, 80286, 80386, 80486 and Pentium(tm) processors. ■ TopStat has been successfully tested with the user base as used in RemoteAccess v2.00, v2.01, v2.02 and v2.50. ■ OS/2 is a registered trademark of IBM Corporation MS-DOS and Windows are a registered trademarks of Microsoft Corporation All other programs are copyright and/or trademarked by their respective author(s) 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 (guess you might be at the point already). This directory is your TopStat system directory. TopStat is fully configurable, and a menu driven setup program is included to allow you to create an config file for your system. The control file is an ascii text file, and can be edited using any text editor if you do not wish to use the setup program. (The options in the control file are covered in section 3.2, 'The TOPSTAT.CTL file' later in this document') 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 RemoteAccess system directory, but if you are running RA without any problems, this should be already be set :) Once you have installed TopStat and configured it, you are ready to produce your first bulletins. The bulletins will be placed in the main Text Files directory as specified in your RemoteAccess configuration file. I've done it this way so that on a multi-language system all languages can display the bulletins without having to copy/move them to each of the language's text files directory. You can run TopStat after every call to the BBS, or in a nightly maintenance event. Please Note: TopStat will try and use share to open all the files it needs. This will allow multi-node BBS's to run it without having to take all the nodes down first. ┌─ │ 3.1 Command Line └────────────────────────────────────────────────────────────────────────────── TopStat no longer supports command line options. All configuration is now done via the control file. ┌─ │ 3.2 The TOPSTAT.CTL file └────────────────────────────────────────────────────────────────────────────── As mentioned before, the configuration file will allow you to fully configure TopStat to your system. The best way to create an initial configuration file is to run the setup program, which will attempt to auto-detect some of the options for your system (mainly which version of RemoteAccess you are using). If you are upgrading from a previous TopStat installation, run the setup program and save the configuration. This will produce an updated config file. (This is not really necessary since TopStat can use any old config options) Please remember to save the control file before you exit the setup program. The options in the configuration file can be in any order, and any line starting with a ';' (no quotes) is considered to be a comment line and is not processed. Here is a list of options you can use, and a short description of what they do. General Settings ---------------- BBSSoftware The 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 ASCII output bulletins. ANSi Produce ANSi output bulletins. AVATAR Produce AVATAR output bulletins. 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 A??_FileReport The File Ratio Report 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_ included all the information for a security level on one line. The description must have any spaces replaced by an underscore (_) There needs to be a minimum of one space between each field (level, description, time limit and download limit). 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 security 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 please!!) 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 RemoteAccess 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, 300 to 33,600 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 The TOPSTAT.CTL file └────────────────────────────────────────────────────────────────────────────── 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 └──────────────────────────────────────────────────────────────────────────────