home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / SPITFIRE / SFDIZ.ZIP / SFDIZ.DOC < prev    next >
Text File  |  1994-01-01  |  7KB  |  161 lines
  1.                                   SFDIZ
  2.                           SPITFIRE FILE_ID.DIZ
  3.                                Version 1.0
  4.                     Copyright (C) by Mike Woltz, 1994
  5.                           Buffalo Creek Software
  6.     
  7.  
  8.     INTRODUCTION
  9.     ------------
  10.     
  11.        SFDIZ is a utility written by Mike Woltz, author of SPITFIRE
  12.     Bulletin Board System.  SFDIZ is designed to be used with SPITFIRE
  13.     for the purpose of updating SPITFIRE's SFFILES.BBS file description.
  14.     SFDIZ will replace an existing file description in the SFFILES.BBS
  15.     with the appropriate ZIP file's FILE_ID.DIZ, if it exists.  SFDIZ
  16.     will only work with files which are compressed using the ZIP archive
  17.     format.  For files using a compression technique other than ZIP or if
  18.     the ZIP file does not contain a FILE_ID.DIZ the file description is 
  19.     not modified.  SFDIZ, however, will refresh the file size of each file
  20.     in the SFFILES.BBS listing.
  21.     
  22.     
  23.     USAGE
  24.     -----
  25.       
  26.        In order for SFDIZ to work properly, it must be able to find
  27.     SPITFIRE's SFAREA.DAT file.  There are two ways in which this
  28.     can be accomplished.  First, execute SFDIZ from the SPITFIRE home
  29.     directory or include the following statement:
  30.    
  31.     SET SFPATH=C:\SF
  32.    
  33.     in your AUTOEXEC.BAT file.  (C:\SF should be modified to reflect
  34.     the drive and path of the SPITFIRE home directory on your system.)
  35.    
  36.        When executed SFDIZ must be able to locate SFAREA.DAT.  It
  37.     first checks to see if SFAREA.DAT is in the current directory.
  38.     If not found, SFDIZ checks the environment for the SET SFPATH
  39.     location.  If unable to locate SFAREA.DAT, SFDIZ terminates
  40.     with the error message:
  41.     
  42.     SFAREA.DAT not found.
  43.     Operation Halting!
  44.     
  45.        Also, in order for SFDIZ to function properly, PKUNZIP.EXE
  46.     must reside in the directory from which SFDIZ is executed or
  47.     it must reside in a directory which is included in your path
  48.     statement.  (If you are unfamiliar with the DOS path statement,
  49.     refer to your DOS documentation.)
  50.     
  51.     
  52.     COMMAND LINE PARAMETER OPTION
  53.     -----------------------------
  54.     
  55.        SPITFIRE's (v3.4 or earlier versions of SPITFIRE) SFFILES.BBS
  56.     limits each file listing to 255 characters.  SFDIZ will include 
  57.     as much of the file description contained in FILE_ID.DIZ as
  58.     possible, up to the 255 character limit.
  59.     
  60.        BBS systems which have been configured to include a line
  61.     which adds "Uploaded By..." to the file description have an
  62.     additional option available to them.  If no command line
  63.     parameter is included when executing SFDIZ, the "Uploaded By..."
  64.     line will remain as part of the file description.
  65.     
  66.        However the command line parameter, /R, can be used to
  67.     remove the "Uploaded By..." line from the description to allow
  68.     more of the FILE_ID.DIZ description to be included in the SFFILES.BBS
  69.     file description.  The command line format to use the optional command
  70.     line parameter would be entered as follows:
  71.     
  72.     SFDIZ /R
  73.     
  74.     When using the above command line, SFDIZ would remove the 
  75.     "Uploaded By..." line from each of the SFFILES.BBS file 
  76.     descriptions.
  77.  
  78.  
  79.     HOW SFDIZ WORKS
  80.     ---------------
  81.  
  82.        SFDIZ will process through each File Area configured in
  83.     SPITFIRE's SFAREA.DAT.  If the File Area is configured as a
  84.     CD-Rom File Area, SFDIZ will not attempt to update the file
  85.     descriptions.  The message:
  86.     
  87.     Skipping CD-Rom Area!
  88.     
  89.     will be displayed for File Areas which have been configured
  90.     as a CD-Rom File Area.
  91.     
  92.        For each file which is not configured as a CD-Rom File Area,
  93.     SFDIZ will display the File Area number and the File Area 
  94.     description.  Next, it will display the prompt:
  95.     
  96.     Create new SFFILES.BBS using FILE_ID.DIZ? [Y/n]
  97.     
  98.        If you respond with N, SFDIZ will simply proceed to the 
  99.     next File Area.
  100.     
  101.        If you press the Enter key (SFDIZ defaults to responding
  102.     with a Y) or enter Y, SFDIZ will begin processing the descriptions
  103.     for this File Area.
  104.     
  105.        For every ZIP file, SFDIZ will attempt to extract a FILE_ID.DIZ
  106.     file.  If FILE_ID.DIZ is found within the ZIP archive, SFDIZ
  107.     will replace the current SFFILES.BBS description with the contents
  108.     of the FILE_ID.DIZ, up to the 255 character limit.
  109.     
  110.     ** NOTE **  Using the /R command line parameter to remove the
  111.     "Uploaded By..." descriptive line will allow SFDIZ to include
  112.     more of the FILE_ID.DIZ description.
  113.     
  114.        In addition to replacing the file description with the description
  115.     contained in FILE_ID.DIZ, SFDIZ will also compare the file size
  116.     in SFFILES.BBS to the actual size of the file and update it
  117.     accordingly.
  118.     
  119.        Also, if SFDIZ finds a file listing in the SFFILES.BBS and the
  120.     file does not exist on the drive, the following prompt will appear:
  121.     
  122.     <Filename.ext> not found on drive!
  123.     Do you wish to remove it from SFFILES? [Y/n]
  124.     
  125.        If you respond with N, the listing is not removed or modified
  126.     in the SFFILES.BBS.  However, if you press Enter (SFDIZ defaults
  127.     to Y) or respond with Y, SFDIZ will remove the file from the
  128.     SFFILES.BBS listing.
  129.     
  130.        It should also be noted that as a precautionary measure, SFDIZ 
  131.     creates a file called SFFILES.ORG which is a backup of the original
  132.     SFFILES.BBS for each File Area it processes.
  133.  
  134.  
  135.     DISTRIBUTION
  136.     ------------
  137.  
  138.        SFDIZ is distributed under the shareware concept.  You are
  139.     free to distribute the SFDIZ program as long as it remains
  140.     unmodified and no fee is charged.  SFDIZ is provided as a 
  141.     complimentary SPITFIRE utility to all registered SPITFIRE Sysops.
  142.     Happy New Year 1994!
  143.     
  144.  
  145.     DISCLAIMER
  146.     ----------
  147.         
  148.        Mike Woltz and/or Buffalo Creek Software shall in no way be 
  149.     held responsible for any damage incurred while operating SFDIZ.
  150.     All responsibility lies with the user of the software.
  151.  
  152.        The documentation for SFDIZ is contributed by Jacque
  153.     Shipley and The Mother Board BBS.  The shareware version of
  154.     SPITFIRE and other SPITFIRE utilities are available for download
  155.     from:
  156.  
  157.          Buffalo Creek's BBS              The Mother Board BBS
  158.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  159.            (515) 225-8496                    (515) 986-3464
  160.          57600 - 1200 Baud                 14400 - 1200 Baud
  161.