--------------------------------------------------------------------------
--------------------------------------------------------------------------
      Docs to Smash*Palace Board Utility V0.99 - Preliminary release
        Documentation typed by Dr. Reynolds of Smash*Palace Amiga!
--------------------------------------------------------------------------
--------------------------------------------------------------------------
             Call these FINE Smash*Palace Alliance boards:

                  Smash*Palace Amiga      (512) 696-1666
                  Smash*Palace HQ         (409) 762-0839
                  Smash*Palace California (213) 670-2211

                 With all the latest and greatest warez!!
--------------------------------------------------------------------------
--------------------------------------------------------------------------

August 8, 1990

     This is the "how-to" file for the preliminary release of the 
Smash*Palace Board Utility.  The following is a listing of the files 
contained in the archive smash.zoo:

File                   Destination            Function
---------------------------------------------------------------------
smashutil              This goes in the       This is the actual utility 
                       bbs: directory 

spscript               This also goes         An example batch file for  
                       in the bbs:            running smashutil. Generates
                       directory              last callers and top 10
                                              u/lers and d/lers after
                                              user hangs up

readme                                        You know what this is


The file spscript works as is, but you may need to modify it to generate
files that suit your own personal needs.
--------------------------------------------------------------------------

To enable batch file execution after a user had left your system, change
the file "bbsload" located in your s: directory like this:


stack 50000
cd bbs:
express bbs:config1 3 0 0 640 200 -b<filename>

where <filename> is the name of the batch file you wish to execute.

Example: express bbs:config1 3 0 0 640 200 -bspscript

This will allow AmiExpress to update the files each time a user leaves 
your system.

--------------------------------------------------------------------------

Now for an explanation of what the example spscript does. Here is the code:

c:cd bbs:
smashutil -st 6 bbs:exchange/bull20.txt -lc bbs:node0/udlog bbs:node0/bull20.txt
; ALWAYS PUT -st BEFORE -lc. THIS BUG WILL BE CORRECTED NEXT VERSION
c:cd bbs:exchange
c:copy bull20.txt bull30.txt
c:copy bull20.txt bull20.txt.gr
c:copy bull20.txt.gr bull30.txt.gr
c:copy bull20.txt bull255.txt
c:copy bull20.txt.gr bull255.txt.gr
c:cd bbs:node0
c:copy bull20.txt bull30.txt
c:copy bull20.txt bull20.txt.gr
c:copy bull20.txt.gr bull30.txt.gr
c:copy bull20.txt bull255.txt
c:copy bull20.txt.gr bull255.txt.gr
c:cd bbs:

If you notice, three directories are included in the file.  They are:

bbs:            -  This is the one with the express, config, etc files 
                   (along with your smashutil and spscript now)

bbs:node0       -  this is the one with the udlog, user file, etc

bbs:exchange    -  This is the destination directory for the top 10
                   u/lers and d/lers file.  

Most people will not have to modify the source and destination of the
last callers files, unless you have a node other than node0.  I always
send my top 10 files to the exchange conference so that people entering
the transfer section can see the stats.  Change the script file for
destinations of your own choosing.

There are files that will be created called bull20.txt, etc.  The numbers
represent the access level.  You must make a bullXX.txt and bullXX.txt.gr 
for each level of access that you have on your bbs.  These are bulletins 
that are displayed when the user joins a conference.  Please see the 
Ami Express docs for details.

Also, if you notice in line 2 there is a "6"; well, that allows you to set
a ratio for the top uploaders.  The "6" means that if a user is one 
of the top uploaders, yet he has leeched more than 6 times what he has 
uploaded, then he is not included in the top uploaders.  This number can 
be from "0-9".  "0" means to ignore the ratio and "1-9" means a 
download-to-upload ratio of say 4:1 if it was a "4".

Lastly, note that in line 2 there is "udlog".  This is an option that is
turned on in the config program of AmiExpress.  It keeps track of your
callers with their transfer information.  This utility will also use your 
"callerslog" file that is also an option in the config program.  One of
these must be used, and you must put the file that you are using in that 
spot in the line.  It will not work without one or the other.
(Hint: udlog takes up less drive space, and you must remember to keep
up with the file so it doesn't get too large.)

*** AUTHOR'S NOTE ***

        If copy and cd are resident (or ares) on your system, remove all 
of the c: in your script file. You can see if they are resident by typing
"resident" (or ares for Ashell users) from any CLI/Shell prompt.  If they 
are resident, they will be listed.
        If cd and copy are NOT resident, then leave the c: in the script
file for maximum speed.  If they are resident, removing the c: from the
script file will considerably increase the speed of your batch file 
execution. 

--------------------------------------------------------------------------

If you type in smashutil from a shell, you will get the following
message:


[33mSmash*Palace Board Utility - Version 0.99
[33m       Written by: Double Density
[33m     Smash*Palace HQ (409) 762-0839
[33m   Smash*Palace Amiga (512) 696-1666
[33m----------------------------------------[0m

Syntax: smashutil <options>

Options:
-lc <source> <dest file>  -  Last Callers
-st <ratio>  <dest file>  -  Top 10 U/Lers & D/Lers

<ratio> = minimum dl/ul ratio to include (0-9; 0 = ignore ratios)
<source>  = log you wish to use (Example: bbs:node0/callerslog)
<dest file> = name of the file to which you want output directed
Example: smashutil -st 6 stat -lc bbs:node0/udlog Lcaller

[33mComments or suggestions encouraged[0m


The board utility can also be run by you without having the bbs do it 
everytime. You can type in:


smashutil -lc bbs:node0/udlog lcaller

This will create a file called lcaller in bbs:node0 which contains
the callers for the day.  

Or you can type:

smashutil -st 6 stat

That will give you a file called stat with your top 10 uploaders and 
downloaders.

--------------------------------------------------------------------------
--------------------------------------------------------------------------

     Well I would like to thank Double Density for finally coming up
with a bulletin utility that WORKS!!  Others have tried, but this one 
does it without crashing your bbs, screwing up your user file, or 
missing like half the calls you get each day.  This program has been
in Beta testing on Smash*Palace HQ and Smash*Palce Amiga for a month
and we have had virtually no problems.  
        Comments and suggestions are encouraged, as this is the only way 
Double Density's program will continue to evolve.  Since he is the author, 
suggestions, technical questions or complaints should be directed to him
at Smash*Palace HQ.  Non-technical operating questions can be directed 
to any Smash*Palace sysop.

     Keep your eye out for more Smash*Palace releases in the future!

--------------------------------------------------------------------------
*** AUTHOR'S ADDENDUM ***

        Since my last hard drive crash ate the source code for the
Smash*Palace Board Utility, I can't do any of the last minute changes I 
had planned on doing before release of my utility.  Nevertheless, I am
rewriting the entire program from scratch.  THIS IS AN OPPORTUNE TIME
TO MAKE SUGGESTIONS TO ME REGARDING SPECIFIC ADDITIONS YOU WOULD LIKE TO
SEE IN THE NEXT VERSION! If you have any suggestions, please call my
system and leave me mail.  You can leave me mail on the other systems,
but your suggestions will be acted on much more quickly if you contact me
at my own system, as it's often several weeks for me between calls to the
other Smash*Palace systems.
--------------------------------------------------------------------------

The members of Smash*Palace Alliance are:

     Double Density, Dr. Reynolds, The Grimreaper, Superbeagle and Tech

 Greetings to all of our users, our friends, and all the people we know!
  (With the exception of Disector and Static, who are fucking leeches.)

--------------------------------------------------------------------------
