+-----------------------------------------------------------------------------+
| Yet Another AllTop v1.0 |
| Written by Drew [PWA] |
| Docs Last Updated 06-21-95 |
+-----------------------------------------------------------------------------+
+-----------------------------------------------------------------------------+
| 0. Table of Contents |
+-----------------------------------------------------------------------------+
1. Introduction
2. Packaging
3. Installation
4. Configuration
5. Last Words
6. Contacting the Author
+-----------------------------------------------------------------------------+
| 1. Introduction |
+-----------------------------------------------------------------------------+
Yet Another AllTop (YAAT) is your typical PPE which generates all-time
bulletins of various statistics. YAAT creates all-time bulletins of:
- top uploaders by bytes
- top downloaders by bytes
- top uploaders by files
- top downloaders by files
- top callers
- top message posters
Global user exclusions as well as individual exclusions for each bulletin is
available. Options to only generate some of the bulletins is also featured.
YAAT is highly configurable and runs surprisingly fast. If this is still
not enough for you, source code is included for your pleasure as well. :)
Since this is written in PPL 3.0, you must be running PCBoard v15.2 or higher
to use PPE.
+-----------------------------------------------------------------------------+
| 2. Packaging |
+-----------------------------------------------------------------------------+
Your zip file should contain the following files:
ALLTOP.CFG YAAT main configuration file.
ALLTOP.PPS YAAT source code.
ALLTOP.PPE YAAT the PPE itself.
ALLTOP.EXC Global user exclusion file.
ALLTOP.DOC YAAT Documentation (you are reading it now).
BLT\ Default subdirectory for bulletin creation
SHOW\CALL_BOT Footer for Top Callers bulletin
SHOW\CALL_TOP Header for Top Callers bulletin
SHOW\DLB_BOT Footer for Top Downloaders-Bytes bulletin
SHOW\DLB_TOP Header for Top Downloaders-Bytes bulletin
SHOW\DLF_BOT Footer for Top Downloaders-Files bulletin
SHOW\DLF_TOP Header for Top Downloaders-Files bulletin
SHOW\POST_BOT Footer for Top Message Posters bulletin
SHOW\POST_TOP Header for Top Message Posters bulletin
SHOW\ULB_BOT Footer for Top Uploaders-Bytes bulletin
SHOW\ULB_TOP Header for Top Uploaders-Bytes bulletin
SHOW\ULF_BOT Footer for Top Uploaders-Files bulletin
SHOW\ULF_TOP Header for Top Uploaders-Files bulletin
PHALANX.ZIP Configuration files for the setup on my board
AMIX.ZIP Configuration files for an AMI-X setup/look
_CALLERS.EXC User exclusion file for Top Callers bulletin
_DLBYTES.EXC User exclusion file for Top Downloaders-Bytes bulletin
_DLFILES.EXC User exclusion file for Top Downloaders-Files bulletin
_POSTERS.EXC User exclusion file for Top Message Posters bulletin
_ULBYTES.EXC User exclusion file for Top Uploaders-Bytes bulletin
_ULFILES.EXC User exclusion file for Top Uploaders-Files bulletin
OTHERDJP.DOC Other stuff I've written.
FILE_ID.DIZ File (zip) description.
PWA.NFO PWA info file.
TSP.NFO My bbs ad.
Note that all header and footer files have no extension, and is named in
this manner to be language aware.
If any of these files are missing, be warned that you may have a copy
that has been tampered with. If you have any extra files, they are
extraneous and unnecessary.
Typically, my bbs ad may not be there, which is not a problem. However,
the idiots who contribute this to the fidonet backbone (usually originating
from the Clipper Workshop BBS) edit the FILE_ID.DIZ, remove PWA.NFO and
OTHERDJP.DOC, and insert their own bbs ad which is bigger than most ppe's.
Just be aware, since who knows what other stupidities they may pull.
+-----------------------------------------------------------------------------+
| 3. Installation |
+-----------------------------------------------------------------------------+
Unzip (with -d) and place all files into their own directory. One sub-
directory called "BLT" should be created, as this will the place where the
bulletins are created. This location is configurable via "ALLTOP.CFG".
Once this is done, you can install this basically anyplace you wish to.
The most logical place would be to run this on logoff, or if you have a huge
user list, during a nightly event. I will assume that you already have an
idea of how to do this, so will skip the details.
+-----------------------------------------------------------------------------+
| 4. Configuration |
+-----------------------------------------------------------------------------+
Edit "ALLTOP.CFG" for most of the configuration options. It is relatively
short and should be self-explanatory.
User Exclusions: Sometimes you may not want certain users to appear in the
bulletins, hence the need for exclusions. ALLTOP.EXC is the global exclusion
file. Any user listed in here will be excluded from *all* bulletins generated.
If you need to have specific exclusions, simply rename the corresponding files
which begin with "_" and list your users (one per line) in each file. For
example:
_CALLERS.EXC --> CALLERS.EXC
YAAT accepts a number of command line parameters. These are:
QUIET run in "quiet" mode, do not print any messages while running
-BUL don't generate top uploaders by bytes bulletin
-BDL don't generate top downloaders by bytes bulletin
-FUL don't generate top uploaders by files bulletin
-FDL don't generate top downloaders by bytes bulletin
-C don't generate top callers bulletin
-P don't generate top message posters bulletin
There isn't all that much of a speed difference between generating one of the
bulletins and generating all of the bulletins, but these options are there
just in case you need them.
Two sample configuration setups are included. One is the same setup I
have on my own system, while the other is an AMI-X type of style. This just
basically illustrates that even without modifying the source, the ppe is
designed to be as flexible as possible.
+-----------------------------------------------------------------------------+
| 5. Last Words |
+-----------------------------------------------------------------------------+
I can hear the groans already, "Another top bulletin generator!" But
that's why I've called it YAAT : Yet Another AllTop. :) I've had this one
laying around for a while now, but just never bothered releasing it because
everyone and their grandmother is decompiling and writing one. <g>
However, I've finally decided to release this and include source in all
its glory with it. Maybe this will put an end to some of the people who keep
releasing these things over and over again. At one point or another, these
things all become cosmetic, and people tend to just modify the look of it and
say it's a new release, better than before. Big whoop.
So now you have it. Source and everything. If I see another all-time
bulletin generator (or another weektop, last callers, etc.), I will scream. :)
+-----------------------------------------------------------------------------+
| 6. Contacting the Author |
+-----------------------------------------------------------------------------+
I am rarely on IRC, so don't be a dork and bother other PWA members.
Don't ask for source, and don't ask to be a distribution site, because we
don't have any.
You can reach me in the following ways:
Internet email : drew@xinet.com
My BBS : The Silicon Phalanx, 310-575-8567
Other : Attitude Net, PPEnet
Peace,
--Drew
