home *** CD-ROM | disk | FTP | other *** search
/ Shareware 1 2 the Maxx / sw_1.zip / sw_1 / BBS / SF32_2.ZIP / SFBUSY.ZIP / SFBUSY.DOC < prev   
Text File  |  1990-08-15  |  7KB  |  163 lines
  1.                                  SFBUSY
  2.                                Version 1.0
  3.                      Copyright (C) By Mike Woltz 1990
  4.                            Buffalo Creek Software    
  5.                                 A Member Of
  6.                   The Association Of Shareware Professionals
  7.  
  8.     INTRODUCTION
  9.     ------------
  10.  
  11.        SFBUSY is a utility written in Turbo Assembler by Mike Woltz
  12.     and is intended to be used with SPITFIRE Bulletin Board System.
  13.     SFBUSY is used with SFWHOSON.DAT for the purpose of discovering
  14.     whether a caller is logged on SPITFIRE, to set SFWHOSON.DAT to
  15.     disallow any caller from logging on SPITFIRE and to reset
  16.     SFWHOSON.DAT to again allow callers to log on SPITFIRE.  With
  17.     the expansion of SPITFIRE to multi-node capability in Version 3.0,
  18.     this will be desirable, if not mandatory, for some BBS maintenance.
  19.     For instance, when packing message conference files using Bob
  20.     Browne's SFPACK, you will want to insure that no callers are on any
  21.     of the available BBS nodes before beginning the pack and then after
  22.     beginning the pack you will want to insure that no callers can log
  23.     on while the pack is being performed.  Once the maintenance is
  24.     performed, SFBUSY, used with the /C parameter, makes the BBS
  25.     accessible to callers once again.
  26.     
  27.     *SFPACK is a utility copyrighted by Smart Office Solutions and
  28.     part of the SFUTI driver written by Bob Browne.
  29.  
  30.  
  31.     COMMAND LINE USAGE
  32.     ------------------
  33.  
  34.        Two command line parameters are used with SFBUSY.  These are
  35.     /S to SET the utility to perform maintenance and /C to CLEAR
  36.     the maintenance parameter.
  37.     
  38.        SFBUSY should be located in a directory included in your PATH
  39.     so it can be properly executed regardless of the then current
  40.     directory.  In the event SFBUSY is not being executed from the
  41.     directory in which SFWHOSON.DAT resides, then it must be executed
  42.     by providing the path or the drive and path to your WORK file directory
  43.     in the command line prior to the /S or /C parameter.  For instance:
  44.      
  45.     SFBUSY D:\WORK /S
  46.      
  47.        Using SFBUSY with the /S parameter from either the WORK file
  48.     directory or with the WORK file directory specified will result
  49.     in either an ERRORLEVEL 0 or an ERRORLEVEL 2 being returned to
  50.     DOS.
  51.     
  52.        If all nodes on the system are free from use, SFBUSY reports:
  53.        
  54.        Setting maintenance parameter!
  55.        Sending ERRORLEVEL 0 to DOS!
  56.        
  57.        Once this is done, callers can not log on the BBS.  When a caller
  58.     attempts to log on, SFPRELOG.BBS and the WELCOME1.BBS/CLR screens
  59.     are displayed and then prior to the caller entering their name,
  60.     SPITFIRE will display a default message:
  61.     
  62.               "A maintenance operation is being performed!
  63.                Please try again in a few minutes..."
  64.        
  65.         The Sysop may choose to create SFMAINT.BBS/CLR display files which
  66.     would be shown in place of SPITFIRE's default message.
  67.     
  68.        In the event, a caller(s) is on one or more nodes of the BBS, an
  69.     ERRORLEVEL of 2 is returned to DOS and the maintenance parameter
  70.     is not set.
  71.     
  72.        Anytime the maintenance parameter is set, SFBUSY MUST be executed
  73.     with the /C parameter afterwards, to clear the maintenance parameter
  74.     and to once again make the system accessible to callers.
  75.        
  76.        In the event SFBUSY is unable to find SFWHOSON.DAT, the following
  77.     message is displayed:
  78.     
  79.     SFWHOSON.DAT Not Found!
  80.     Sending ERRORLEVEL 1 to DOS!
  81.     
  82.     If an ERRORLEVEL 1 is returned to DOS, SFBUSY will not set the
  83.     maintenance parameter within SFWHOSON.DAT which prevents a caller
  84.     from logging on the BBS.
  85.  
  86.  
  87.     SFBUSY USAGE
  88.     ------------
  89.     
  90.        SFBUSY will most likely be used within the SF.BAT when executing
  91.     SPITFIRE scheduled events. Such an example, again using SFPACK, might
  92.     look like this:
  93.     
  94.          :EVENT_I
  95.          D:
  96.          CD\PCRELAY
  97.          SFBUSY C:\WORK /S
  98.          IF ERRORLEVEL 2 GOTO EVENT_I
  99.          IF ERRORLEVEL 1 GOTO I_END
  100.          SFPACK AREA:1-2 MSGS:200 DAYS:30 NOBAK
  101.          SFPACK AREA:3-20 MSGS:200 DAYS:10 NOBAK NODUP
  102.          SFBUSY C:\WORK /C
  103.          :I_END
  104.          C:
  105.          CD\SF
  106.          GOTO LOOP
  107.     
  108.     Notice, SFBUSY is executed with the /S parameter and once the
  109.     desired maintenance is performed, executed again with the /C
  110.     parameter.  IMPORTANT - SFBUSY MUST BE RUN WITH THE /C PARAMETER
  111.     AFTER IT WAS RUN WITH THE /S PARAMETER.  IN THE EVENT SFBUSY WAS
  112.     SUCCESSFULLY RUN WITH THE /C PARAMETER, SPITFIRE WILL NOT ALLOW
  113.     A CALLER TO LOG ON UNTIL SFBUSY IS RUN USING THE /C PARAMETER.
  114.     
  115.        Please not that in the above example, in the event SFBUSY sends
  116.     an ERRORLEVEL 2 to DOS (meaning a caller is logged on SPITFIRE) then
  117.     it continues to be executed until a permissionable ERRORLEVEL is sent
  118.     to DOS.
  119.     
  120.     IF ERRORLEVEL 2 GOTO EVENT_I
  121.     
  122.        Further, please not that in the above example, in the event SFBUSY
  123.     sends an ERRORLEVEL 1 to DOS (meaning SFWHOSON.DAT was not found) then
  124.     the scheduled maintenance is skipped and control is returned to
  125.     SPITFIRE.
  126.     
  127.     IF ERRORLEVEL 1 GOTO I_END
  128.  
  129.     
  130.     DISTRIBUTION
  131.     ------------
  132.  
  133.        SFBUSY is distributed under the shareware concept.  You are free 
  134.     to distribute the SFBUSY program as long as it remains unmodified and 
  135.     no fee is charged.  If you use this program and find it beneficial, a 
  136.     $1.00 registration fee is required.
  137.     
  138.        The registration fee should be sent to:
  139.        
  140.                            Buffalo Creek Software
  141.                            Attn: Mike Woltz
  142.                            913 - 39th Street
  143.                            West Des Moines, Iowa  50265
  144.  
  145.     
  146.     DISCLAIMER
  147.     ----------
  148.         
  149.        Mike Woltz and/or Buffalo Creek Software shall in no way be held 
  150.     responsible for any damage incurred while operating SFBUSY.  All 
  151.     responsibility lies with the user of the software.
  152.  
  153.  
  154.  
  155.        The documentation for SFBUSY is contributed by Jacque Shipley and 
  156.     The Mother Board BBS.  The shareware version of SPITFIRE, SFBUSY and 
  157.     other utilities written by Mike Woltz are available for download from:
  158.  
  159.          Buffalo Creek's BBS              The Mother Board BBS
  160.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  161.       (515) 225-8496 - 2 Nodes               (515) 986-3464
  162.       38400/9600/2400/1200 Baud         19200/9600/2400/1200 Baud
  163.