home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / SPITFIRE / SFMKLIST.ZIP / SFMKLIST.DOC < prev    next >
Text File  |  1994-01-27  |  11KB  |  243 lines
  1.                
  2.                  >>>>>>>>>>   SFMKLIST.EXE   <<<<<<<<<<
  3.                        (Make SPITFIRE Files List)
  4.                                Version 2.21
  5.                     Copyright (C) By Mike Woltz, 1989-1994
  6.                             Buffalo Creek Software
  7.                   
  8.  
  9.  PURPOSE
  10.  -------
  11.                         
  12.    SFMKLIST.EXE is a utility which enables a Sysop, operating a SPITFIRE
  13.  Bulletin Board System, to create a file listing of the files available on
  14.  their BBS for download.  SFMKLIST will write each existing SFFILES.BBS
  15.  from each file area into a single text file for the user to view, print,
  16.  or download.  The advantage of having such a file available is that
  17.  it provides the user with the ability, not only to use it as reference for
  18.  uploading or downloading, but also to save on-line time browsing through
  19.  the numerous file area listings individually.  This could be especially
  20.  beneficial to long distance callers.
  21.     
  22.  
  23.  USE OF SFMKLIST.EXE
  24.  -------------------
  25.     
  26.    The SFMKLIST.EXE must be placed in the SPITFIRE HOME directory.
  27.  SFFAREA.DAT must reside in the directory for SFMKLIST to execute.
  28.  SFMKLIST.EXE can be executed from the DOS prompt or can be assigned as
  29.  a scheduled event and executed from the SF.BAT file.  (For information on
  30.  scheduled events refer to the SPITFIRE manual - Sysop Menu Explanation).  
  31.  
  32.    When executed, SFMKLIST, will create a text file containing a list of files 
  33.  that are available on the BBS and place it in either File Area #1 (default)
  34.  or the specified File Area (see Command Line Parameters /A below) and add
  35.  the name of the file that has been created (zipped or unzipped - see /Z
  36.  below) to the current SFFILES.BBS listing.  SFMKLIST will automatically enter
  37.  the file size, date and description of "List of files for download on this 
  38.  BBS!" to the SFFILES.BBS.  Each time SFMKLIST is executed it will overwrite
  39.  the existing file list (if present) so the most current is always available
  40.  and recorded in the SFFILES.BBS.
  41.     
  42.  
  43.  
  44.  
  45.  
  46.  COMMAND LINE PARAMETERS
  47.  -----------------------
  48.  
  49.    The below listed command line parameters provide several options which
  50.  the Sysop has available to them when executing the SFMKLIST.EXE.
  51.  
  52.      /A  - Designates the SPITFIRE file area that the file created by 
  53.            SFMKLIST will be placed.  The file area number should follow
  54.            directly after the /A without any spaces.  For instance:
  55.            
  56.            SFMKLIST  /A12
  57.            
  58.            would save the file to File Area #12.  If no File Area is assigned
  59.            the default setting will place the file in File Area #1.
  60.            
  61.      /B  - Allows the Sysop to create a specific header for the file list.
  62.            /B must be followed by a space and then the message entered to be
  63.            used as the header.  For instance:
  64.            
  65.            SFMKLIST /B Buffalo Creek's BBS
  66.  
  67.            would place the message "Buffalo Creek's BBS" at the top of the file
  68.            listing.  If no /B message is specified then the utility will 
  69.            assign a default header of "SPITFIRE Bulletin Board".  The utility
  70.            will also automatically date the file in the upper left hand corner
  71.            of the header.
  72.            
  73.      /E  - Provides the Sysop the ability to exempt various file area(s) from
  74.            the file list created.  No space should exist between the /E and
  75.            the file area number.  However, if you wish to exempt more than 
  76.            one file area a space should exist between each /E#.  For instance:
  77.            
  78.            SFMKLIST /E2 /E5
  79.            
  80.            would create a file listing of all files except those contained in
  81.            File Area #2 and File Area #5.  If no /E switch is defined the
  82.            utility will default to include all SPITFIRE file areas.
  83.  
  84.            SFMKLIST also provides use of a special command line parameter 
  85.            array of File Areas to be excluded from the created list.  For
  86.            instance:
  87.  
  88.            SFMKLIST /E12..19
  89.  
  90.            would create a file listing of all files except those contained in
  91.            File Areas #12,#13,#14,#15,#16,#17,#18 and #19.
  92.  
  93.            The /E command line parameter can be used numerous times during
  94.            execution of SFMKLIST.  For instance:
  95.  
  96.            SFMKLIST /E3 /E12..19 /E24..27 /E32
  97.  
  98.            if permissible.
  99.            
  100.      /F  - Allows the Sysop to specify the name of the file which is created
  101.            by SFMKLIST.EXE.  The /F must be followed by a space and then the
  102.            name of the file to be created must be entered.  This must be an
  103.            valid DOS filename.  For instance:
  104.            
  105.            SFMKLIST /F BCFILE.LST
  106.            
  107.            would name the file created and containing the list of files
  108.            available for download on the BBS to BCFILE.LST.  If no /F
  109.            parameter is specified, SFMKLIST will default to creating a file
  110.            named BBSFILE.LST
  111.  
  112.      /Z  - This parameter will cause SFMKLIST to attempt to zip the created
  113.            text file into a zipped file.  SFMKLIST first looks for PKZIP.EXE
  114.            in the SPITFIRE HOME directory and if necessary, then searches thru
  115.            the directories contained in your DOS PATH. In the event PKZIP.EXE
  116.            is found and the created text file is successfully zipped, then
  117.            SFMKLIST erases the created text file and adds the .ZIP file to the
  118.            appropriate SFFILES.BBS.
  119.  
  120.  
  121.  
  122.            
  123.    The above mentioned command parameters may be used in any combination and
  124.  in any order.  For instance, a command that would include all the command 
  125.  line parameters specified above might look like this:
  126.      
  127.      SFMKLIST /A12 /B Buffalo Creek BBS /E2 /E5 /F BCFILE.LST /Z
  128.  
  129.    This would create a file BCFILE.LST of all file areas on the BBS, except 
  130.  those in File Area #2 and File Area #5, place a header of "Buffalo Creek
  131.  BBS" at the top of the file list along with the current date, and place
  132.  the file to the designated File Area #12.  It would then zip BCFILE.LST
  133.  into a file named BCFILE.ZIP and erase BCFILE.LST.  It would then add the
  134.  file name, etc., to the existing SFFILES.BBS in that particular file area. 
  135.      
  136.    Executing SFMKLIST without designating any parameters would create
  137.  a file named BBSFILE.LST containing a list of all files existing on the
  138.  BBS, place a header of "SPITFIRE Bulletin Board" at the top of the file
  139.  and then save the file to File Area #1.  It would then add the listing
  140.  for BBSFILE.LST to the existing SFFILES.BBS in File Area #1.
  141.      
  142.      
  143.  POSSIBLE ERROR MESSAGES
  144.  -----------------------
  145.  
  146.      1.  Should you attempt to execute SFMKLIST from a directory which does
  147.          not include the SFFAREA.DAT file, a message will display that the
  148.          SFFAREA.DAT file was not found and execution of SFMKLIST is Halting!
  149.          
  150.      2.  Although unlikely, if a problem should occur creating the file list,
  151.          a message will display that an error has occurred writing the file
  152.          list and the execution of SFMKLIST is Halting!
  153.      
  154.      3.  If the Sysop should attempt to save the file to a non-existing
  155.          SPITFIRE File Area, SFMKLIST will display an error message
  156.          stating that an error occurred reading SFFAREA.DAT and that
  157.          the execution of SFMKLIST is Halting!  For example, if the Sysop
  158.          has specified the file created be saved to File Area 25 by using
  159.          /A25 and only 15 SPITFIRE file areas exist, this message would then
  160.          be displayed.
  161.  
  162.      4.  Each time before SFMKLIST actually creates the file, it will check
  163.          to see how much free disk space is available.  At least 100,000 
  164.          bytes must be free or SFMKLIST will display an error message that
  165.          there is not enough free disk space and that the execution of
  166.          SFMKLIST is Halting!
  167.  
  168.  
  169.  
  170.  
  171.  FILE SHARING
  172.  -------------
  173.  
  174.    SFMKLIST provides full file sharing compatibility in conjunction with the
  175.  DOS SHARE command.  When loaded, SFMKLIST determines if the DOS version is
  176.  3.0 or newer and whether the SHARE command is loaded.  In the event SHARE
  177.  has been loaded, SFMKLIST it will perform all the required file locking
  178.  techniques to insure that the program will operate properly within either
  179.  a multi-tasking or network environment.
  180.  
  181.  
  182.  DISTRIBUTION
  183.  ------------
  184.  
  185.    SFMKLIST.ZIP distribution package includes the SFMKLIST.EXE and the 
  186.  SFMKLIST.DOC files.  This product is being distributed as Shareware and 
  187.  if you find this program useful to you, a mandatory $1.00 registration
  188.  fee is required.   Registrations should be sent to:
  189.  
  190.                         Buffalo Creek Software 
  191.                         Attn: Mike Woltz
  192.                         913 - 39th Street
  193.                         West Des Moines, Iowa 50265  
  194.  
  195.  
  196.  DISCLAIMER
  197.  ----------
  198.  
  199.    Mike Woltz and/or Buffalo Creek Software shall in no way be held 
  200.  responsible for any damage incurred while operating SFMKLIST.  All 
  201.  responsibility lies with the user of the software.
  202.  
  203.    The documentation for SFMKLIST is contributed by Jacque Shipley and 
  204.  The Mother Board BBS.  The shareware version of SPITFIRE and other SPITFIRE
  205.  utilities are available for download from:
  206.  
  207.          Buffalo Creek's BBS              The Mother Board BBS
  208.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  209.            (515) 225-8496                    (515) 986-3464
  210.     38400/19200/9600/2400/1200 Baud        9600/2400/1200 Baud
  211.     
  212.  
  213. REVISIONS:
  214.   Version 1.6 - February 9, 1992
  215.      SFMKLIST was changed to support multi-line file descriptions and
  216.      to support File Areas marked as CD-Rom areas.
  217.  
  218.   Version 1.7 - June 6, 1992
  219.      The February 9, 1992 revision did not report the number of files
  220.      and download bytes per File Area and per total system.  This
  221.      problem has been fixed.
  222.  
  223.   Version 2.0 - August 16, 1992
  224.      SFMKLIST was changed to allow the exemption of File Areas through
  225.      the use of a command line parameter array.  For example, all previous
  226.      versions of SFMKLIST required a /E<x> command line parameter for each
  227.      File Area to be exempt from the created file list.  Now, File Areas
  228.      can be exempt from the list through special array command line.  For
  229.      example, /E12..19 would cause File Areas 12 through 19 to be excluded
  230.      for the created list.  The purpose of this change is to allow a greater
  231.      number of File Areas to be excluded.
  232.  
  233.   Version 2.1 - September 13, 1992
  234.      SFMKLIST was changed to properly count the number of files.
  235.  
  236.   Version 2.2 - December 28, 1993
  237.      SFMKLIST was changed to properly convert the SPITFIRE v3.5
  238.      SFFILES format.
  239.  
  240.   Version 2.21 - January 27, 1993
  241.      SFMKLIST would not exclude over 255 File Areas from the created 
  242.      list.  This has been changed so that up to and including 1000 File
  243.      Areas can be excluded.