home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / FARCL21B.ZIP / FARCL21ß.DOC < prev   
Text File  |  1993-11-21  |  13KB  |  319 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.                    FARCL - The RBBS Fms ARChive Listing utility
  27.  
  28.  
  29.                                    version 2.1ß
  30.  
  31.                                 Copyright (c) 1993
  32.                                   by Bob Hampton
  33.  
  34.                                S3-Technologies BBS
  35.                                     Burke, VA
  36.                                   (703)451-9509
  37.  
  38.  
  39.  
  40.           FARCL 2.1ß                                             Page 2
  41.  
  42.  
  43.           INTRODUCTION
  44.           ------------
  45.  
  46.                FARCL  was inspired by  Michael Walsh's original  FMSARC
  47.           utility  for  RBBS,  which  examines  a  specified  RBBS  FMS
  48.           directory,   and  compares  the  files  listed  to  the files
  49.           actually  found on the disk.  Like  FMSARC, it marks the file
  50.           description in the  FMS directory with a leading asterisk (*)
  51.           for any files  not found on the drive,   and  will  produce a
  52.           changes  file  which lists  all the  files  that were marked.
  53.           There are certain differences in the way that FARCL operates,
  54.           though, and the output it produces.
  55.  
  56.                Like Michael, part of my desire for this type of utility
  57.           is due to lack of available disk space,  but I feel there are
  58.           other factors that make this type of utility handy also.   As
  59.           a user on other  BBSes,  I don't like  having to look through
  60.           huge directory listings  where there are often many different
  61.           versions of the same file available -  I'm usually interested
  62.           only in the most current version of the file.   As a sysop, I
  63.           could delete these old versions, along with the  FMS listing,
  64.           but that would not solve all my problems.  First, it would be
  65.           tedious work to manually search through the FMS directory and
  66.           make the  changes.   Second,  deleting the file  would allow
  67.           another user  to upload one of the older versions again.
  68.  
  69.                My solution  has been to archive off  all older versions
  70.           of files, and to keep the FMS listing for them, BUT to change
  71.           the category  code for  each file  marked  as offline.   This
  72.           frees up  disk  space,  and unclutters  the normal  directory
  73.           listings.   The trick in preventing a user from uploading one
  74.           of the offline files is to create a  "dummy" file of the same
  75.           name, but containing 0 bytes.   FARCL will do this for you by
  76.           specifying the DOS directory in which to create these "dummy"
  77.           files in one of the FARCL config file parameters.
  78.  
  79.  
  80.  
  81.  
  82.           A QUICK NOTE
  83.           ------------
  84.  
  85.                This program and its documentation are Freeware.  It may
  86.           be  freely copied  and distributed,  as long as no monies are
  87.           accepted in exchange.  The only exception  would be a nominal
  88.           charge, not to  exceed $1.00,  in order to cover the costs of
  89.           duplication.  All distributions must include this document.
  90.  
  91.  
  92.  
  93.           FARCL 2.1ß                                             Page 3
  94.  
  95.  
  96.           NEW FEATURES IN VERSION 2.1ß
  97.           ----------------------------
  98.  
  99.                FARCL now works with LARGE file collections, which prev-
  100.           iously caused "out of memory" errors.
  101.                                                              
  102.  
  103.  
  104.           INSTALLATION AND OPERATION
  105.           --------------------------
  106.  
  107.                Installation and setup are very easy.  Simply place the
  108.           file  FARCL.EXE  in whatever directory  you intend to run it
  109.           from.   You will also need a text editor to  create a config
  110.           file, which passes certain parameters to FARCL.
  111.  
  112.                The command to execute FARCL is as follows:
  113.  
  114.                                FARCL <config file>
  115.  
  116.           where  <config file>  is the complete  pathname to the  FARCL
  117.           configuration  file you  wish to  use.   You do  not need  to
  118.           include the drive and directory in the path if both FARCL.EXE
  119.           and the config file are in the current directory. If no config
  120.           file is specified on the command line, the default config file
  121.           FARCL.CFG will be used.
  122.  
  123.                The configuration file must conform to the following
  124.           format:
  125.  
  126.           Line  Description
  127.           ----  ------------------------------------------------------
  128.            1    Complete path to FMS directory file to check
  129.            2    Character to use as offline mark <optional: default = '*'>
  130.            3    New category code given to offline files <optional>
  131.            4    Directory to create dummy files in <optional>
  132.            5    Complete path to changes file to write
  133.            6    Download directory to search
  134.            .
  135.            .
  136.            .
  137.           <end>   "          "     "     "
  138.  
  139.  
  140.                The following is an example of a FARCL config file:
  141.  
  142.           C:\RBBS\MASTER.DIR
  143.           ~
  144.           OFL
  145.           E:\OFL
  146.           C:\RBBS\CHANGES.TXT
  147.           D:\PROG
  148.           D:\UTIL
  149.           E:\COMM
  150.  
  151.  
  152.  
  153.           FARCL 2.1ß                                             Page 4
  154.  
  155.  
  156.           In this case,  FARCL  will check and update the FMS directory
  157.           C:\RBBS\MASTER.DIR,  and will  mark the offline  files with a
  158.           new category code of  OFL.  It will put a tilde (~) character
  159.           in  position 33  of the line so viewers will know the file is
  160.           offline.  Dummy files will be created in directory E:\OFL for
  161.           all files that are offline.  The download directories it will
  162.           check are D:\PROG, D:\UTIL,  and E:\COMM.  Any files found in
  163.           MASTER.DIR but not  found in the download directories will be
  164.           marked  as offline.    A list of offline files will be put in
  165.           C:\RBBS\CHANGES.TXT.
  166.  
  167.           NOTE:  The offline  character, new category code, and the
  168.                  "dummy"  file directory are  optional,  but if not
  169.                  used,  a carriage return must be entered for lines
  170.                  2-4.  Do not enter any spaces in the blank lines -
  171.                  just a carriage return!   If no character is given
  172.                  for the offline mark, an asterisk (*) will be used
  173.                  by default.
  174.  
  175.                 A request was made for  FARCL to handle  FMS directory
  176.           files in which a sysop  has formatted the filenames  so that
  177.           the name  and the extension are  separated by spaces instead
  178.           of a dot.  In other words,  a filename in the  FMS directory
  179.           can now appear in one of three ways as illustrated below:
  180.  
  181.  
  182.              FILE1.ZIP       (standard)
  183.              FILE1     ZIP   (formatted)
  184.              FILE1    .ZIP   (dot-formatted)
  185.  
  186.  
  187.  
  188.           The number of spaces between the file name and the extension
  189.           is variable, as long as it does not conflict with the remain-
  190.           der of the line.  There must be at least one space or the dot
  191.           character between the name and the extension. There can be no
  192.           spaces between the dot (if used) and the file extension.
  193.  
  194.  
  195.           MORE ABOUT "DUMMY" FILES
  196.           ------------------------
  197.  
  198.              Because RBBS only checks the DOS download directories (and
  199.           not the FMS files) when a user tries to upload a file,  it is
  200.           possible for users to upload copies of files you have removed
  201.           and marked offline. In order to be able to prevent users from
  202.           doing this, I reached a compromise whereby FARCL can create a
  203.           file of 0-byte length for each file it marks as offline. That
  204.           way, when a user tries to upload an offline file,   RBBS will
  205.           find a matching filename and prevent the upload.  The tradoff
  206.           is the 32 bytes used on the disk for each 0-byte file that is
  207.           created.  If you wish to utilize this feature   (FARCL config
  208.           line #4),  there are  several things to  consider in deciding
  209.           how to implement it.
  210.  
  211.              First, you must create the DOS directory in which to  hold
  212.           these 0-byte filenames, and add that directory to the list of
  213.           RBBS download directories (RBBS config parameter 208).
  214.  
  215.  
  216.  
  217.           FARCL 2.1ß                                             Page 5
  218.  
  219.  
  220.              Second,  you must decide whether or not to add this direc-
  221.           tory to the list of directories for FARCL to search.    FARCL
  222.           creates a  changes file  each time you run it,   deleting the
  223.           previous changes file before starting.  If you do not add the
  224.           "dummy" file directory to the FARCL directory list, FARCL will
  225.           locate all files that are not in the other directories,   and
  226.           will create a master list of all files that are offline.  If,
  227.           however, you decide to put this directory in the list of FARCL
  228.           directories,  FARCL  will locate  all previously marked files,
  229.           and will create a list of only the most recently marked files.
  230.           This may be useful to some sysops,  but you  must remember to
  231.           either rename or relocate your previous changes file,  if you
  232.           wish to save that information.
  233.  
  234.  
  235.           LIMITATIONS AND FUTURE CONSIDERATIONS
  236.           -------------------------------------
  237.  
  238.                As of this time, FARCL can handle at most 100 download
  239.           directories.  I do not think that this will be a serious
  240.           limitation for most sysops.  If feedback indicates otherwise,
  241.           I can increase that amount.
  242.  
  243.              Keep those cards and letters coming!  Your suggestions are
  244.           always taken into consideration!
  245.  
  246.  
  247.           Regards,
  248.           Bob Hampton
  249.           Sysop: S3-Tech BBS
  250.                  Burke, VA
  251.                  (703) 451-9509
  252.  
  253.  
  254.  
  255.           FARCL 2.1ß                                             Page 6
  256.  
  257.  
  258.  
  259.  
  260.           HISTORY:
  261.  
  262.                    Date
  263.           Version  Released  Comments
  264.           -------  --------  ------------------------------------------
  265.  
  266.             1.0    09-30-90  First public release.
  267.  
  268.             1.01   10-07-90  Changed default config filename to FARCL.CFG
  269.                              (was improperly left with pre-release name of
  270.                              RBBSARC.CFG).  Corrections to documentation.
  271.                              First release to include source code.
  272.  
  273.             1.10   10-15-90  Corrected bug where header line (i.e. - line
  274.                              beginning with "\FMS") was treated as a file
  275.                              and marked as offline.  Added user-definable
  276.                              character to be used as offline mark.  FARCL
  277.                              now will parse formatted as well as dotted
  278.                              filenames in the directory.
  279.  
  280.             1.20   10-19-90  Added support for chained FMS directories.
  281.                              Thanks to Walter Ames of the Greyhawk BBS
  282.                              - (301) 461-9943.
  283.  
  284.             1.21   10-21-90  Corrected situation where old changes file
  285.                              was not being deleted before creating the
  286.                              new one.
  287.  
  288.             1.22   11-29-90  Corrected bug that occassionally caused
  289.                              FARCL to lose it's position in the FMS
  290.                              file.  Corrected documentation to indicate
  291.                              correct usage of chained FMS directories.
  292.                              Thanks to Bruce Marusich of the Street
  293.                              Noise BBS - (301) 601-8710.
  294.  
  295.             1.23   12-05-90  Corrected bug in reading chained FMS
  296.                              directories.  A dumb oversight that took
  297.                              two minutes to fix.  Thanx to Walter Ames
  298.                              of Greyhawk for pointing this out.
  299.  
  300.             1.30   12-08-90  Added capability to create dummy files
  301.                              so that RBBS could prevent a user from
  302.                              uploading offline files.  Thanx to Butch
  303.                              Levy of the Wasteland BBS - (301)864-1132.
  304.  
  305.             1.40    1-05-91  Added attractive display screen.  Improved
  306.                              code to handle "dot-formatted" filenames in
  307.                              FMS files.  Improved code to parse all FMS
  308.                              header lines correctly
  309.  
  310.             1.41    3-17-92  Corrected recognition of special characters
  311.                              '*' and '=' in first position of filename.
  312.                              Thanx to Rene Thomsin for pointing this one
  313.                              out.
  314.  
  315.             2.1ß   11-18-93  BETA RELEASE.  Added ability to handle LARGE
  316.                              collections of files (over 5000).  Thanx to
  317.                              John Palazzolo of J.P.'s Place BBS for the
  318.                              gentle prodding that got me off my butt to
  319.                              make this long-awaited change! <G>