home *** CD-ROM | disk | FTP | other *** search
/ Monster Disc 2: The Best of 1992 / MONSTER1.ISO / bbs / rbbs / fms-103.zip / README.FMS < prev    next >
Text File  |  1992-04-09  |  12KB  |  253 lines
  1.                           RBBS-FMS OffLine Catalogue
  2.                           File Generator and Reader
  3.  
  4.                           Documentation Version 1.0
  5.  
  6.                         Copyright 1992, by Rob Chandler
  7.  
  8.  
  9.        ┌─────┬──────────────────────────────────────────────────────────┐
  10.        │ 1.0 │░░░ LICENSING, DISTRIBUTING AND WARRANTY ░░░░░░░░░░░░░░░░░│
  11.        └─────┴──────────────────────────────────────────────────────────┘
  12.  
  13.        The RBBS-FMS Master Directory Splitter, Off-Line Reader and Off-
  14.        Line File Merger programs are provided as-is.  You may distribute
  15.        them, as long as you do not modify any of the EXE files included
  16.        with the package.
  17.  
  18.        Please support the hours of writing, testing and debugging, by
  19.        registering this software ($15 for the set).
  20.  
  21.        The author will not be held liable to you or anyone for any
  22.        direct, indirect, incidental or consequential damages, including
  23.        any lost profits, lost savings, which may result from the use or
  24.        inability to use this software.  (It's unfortunate this has to be
  25.        in here.)
  26.  
  27.  
  28.  
  29.        ┌─────┬──────────────────────────────────────────────────────────┐
  30.        │ 2.0 │░░░ INTRODUCTION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  31.        └─────┴──────────────────────────────────────────────────────────┘
  32.  
  33.          The idea for these programs is the result of a "what if" session
  34.        at the Fiorito (Dan's the Sysop at SYS-COM) residence.  The enclosed
  35.        set of programs are the result of several late night sessions (gee
  36.        Rob, a search feature would be real nice) and input from the BBS
  37.        members ("will you guys quit getting beer in server!").
  38.  
  39.  
  40.          This package consists of 3 programs (SPTFMS is only needed by
  41.        the SysOp, RDFMS and MRGFMS are used by the members):
  42.  
  43.  
  44.  
  45.          SPTFMS.EXE
  46.                                   OverView
  47.  
  48.            This program will read through your RBBS/FMS master directory
  49.          file and create separate files ("sub-files") based on category code.
  50.          These individual files may be downloaded by BBS members viewed
  51.          offline with RDFMS (described later).  A header advertising your BBS
  52.          may included at the top of each of the "sub-files".  Private files
  53.          (category ***) are excluded from this process and directory chaining
  54.          is supported.
  55.  
  56.                                 The Details
  57.  
  58.            You must have at least 40 files defined in your config.sys, this
  59.          program will run faster if you allocate more files (up to 60).  On
  60.          some multi-tasking systems you may need to allocate more than 60 files.
  61.            When running SPTFMS, the following information will be required:
  62.  
  63.            a) Master Directory Name
  64.                  This is the name of the FMS directory file that is to be
  65.                processed.  If this is your first time using SPTFMS, I
  66.                suggest using your master directory (the one that contains
  67.                all your BBS files). On subsequent runs (ex: monthly), you
  68.                can process a smaller file that contains only the files added
  69.                to your BBS since the last time SPTFMS was used.  This way,
  70.                your members will only have to download the updated information
  71.                and not the entire master file.
  72.  
  73.            b) Temporary File Name
  74.                  This is a work file used by SPTFMS and equal to the size
  75.                of the file specified in step a).  An alternate drive may be
  76.                used for this file by giving the full path.
  77.                  HINT - Don't bother using a RAM drive for this file, there
  78.                         isn't much speed advantage.
  79.  
  80.            c) Sub-File Prefix
  81.                  This field allows you to define your own sub-file name.
  82.                You are allowed a maximum of 4 characters (ex: MSTR).  The
  83.                structure of the "sub-file" names is:
  84.                   ppppccc.eee  where pppp is: the prefix name given
  85.                                      ccc  is: the category code (ex: 001)
  86.                                      eee  is: the extension specified.
  87.                   HINT - When creating monthly "update" files, you should
  88.                          an extension based on the date the "update" files
  89.                          belong to.
  90.                           (ex: April '92 would be .D92, A represents Jan,
  91.                           through to L which represents Dec.  The 92 of
  92.                           course is the year).
  93.                   HINT - Use a RAM drive here (if you can make one large
  94.                          enough to contain all the "sub-files").  There
  95.                          is a great improvement in processing speed.  If
  96.                          you can't set up a big enough RAM drive, then
  97.                          defragmenting your hard drive before running
  98.                          SPTFMS will help.
  99.  
  100.            d) Sub-File Extension
  101.                  This field lets you specify the file extension you wish
  102.                to use (ex: .DIR, the . is required).
  103.  
  104.            e) ASCII Header File
  105.                  A NON-COLOUR ASCII header (max 15 lines) may be inserted
  106.                into each "sub-file" by specifying the name of the header
  107.                file.  To skip this option, leave this field blank or use
  108.                the name NONE.
  109.  
  110.            f) Follow FMS Dir Chain
  111.                  This option tells SPTFMS to continue with the next FMS
  112.                Directory file.  The name of the "chain to" file is
  113.                contained at the top of the current Master Directory File
  114.                (see your RBBS doc's for more details).
  115.  
  116.  
  117.  
  118.          RDFMS.EXE
  119.                                   OverView
  120.  
  121.            This program will let your members read through the "sub-files"
  122.          offline.  RDFMS requires an additional file named DIR.CAT, which
  123.          contains the "sub-file" prefix and extension used by the SPTFMS
  124.          program as well as the category code, category group and category
  125.          description for each active area on your BBS (see sample DIR.CAT).
  126.          You may also supply a help file (RDFMS.HLP) if you wish.
  127.  
  128.                                 The Details
  129.  
  130.            On the first screen, a list of category numbers and descriptions
  131.          are shown.  After selecting an area of interest (a mouse may be
  132.          used to make the selection), a second screen appears with several
  133.          options.  The up/dn arrow keys are used to scroll through the text
  134.          one line at a time and the page up/dn keys display the text one
  135.          screen at a time.  Text searching is available by pressing "S", then
  136.          specifying the text (not case sensitive) you are looking for.  The
  137.          entire file can be printed by selecting "P".  Pressing ESCape will
  138.          return you to the first screen.  You may also supply a help file
  139.          (RDFMS.HLP) if you wish.  The help file be up to 68 characters wide
  140.          and 170 lines long.
  141.  
  142.  
  143.  
  144.          MRGFMS.EXE
  145.                                   OverView
  146.  
  147.            This program will let your members merge the new "update files"
  148.          with their existing "sub-files".  The ASCII header will be removed
  149.          from their old file and replaced with the new one contained in the
  150.          "update".  This program has two options, the first is a manual
  151.          update where your member updates one category at a time, the second
  152.          option (F2) is an automatic update.  The automatic option will
  153.          update all "sub-files" for a given date.  MRGFMS requires an
  154.          additional file named DIR.CAT, which contains the "sub-file"
  155.          prefix and extension used by the SPTFMS program as well as the
  156.          category code, category group and category description for each
  157.          active area on your BBS (see sample DIR.CAT).  You may also supply
  158.          a help file (MRGFMS.HLP) if you wish.  The help file be up to 68
  159.          characters wide and 170 lines long.
  160.  
  161.                                 The Details
  162.  
  163.            On the first screen, a list of category numbers and descriptions
  164.          are shown.  After selecting the area to be updated (a mouse may be
  165.          used to make the selection), or using F2 the activate the Automatic
  166.          option, a second screen appears showing which category will be updated
  167.          and the date of the update.  Automatic mode will update all categories
  168.          for a given period.
  169.  
  170.  
  171.  
  172.          SAMPLE FILES INCLUDED
  173.  
  174.            SPTFMS-A.CFG  Contains the settings from the last time SPTFMS
  175.                     was used.  This file is only required by the host BBS.
  176.  
  177.            DIR.CAT       The first line of this file contains the sub-file
  178.                     prefix and extension used by the SPTFMS program.  The
  179.                     remainder contains the category code, category group,
  180.                     and category description for each active area on the
  181.                     host BBS.  This file is required on the host BBS and
  182.                     the members' system.
  183.  
  184.            HEADER.ANS    This is a sample ANSI header file (only required
  185.                     by the host BBS).
  186.  
  187.            SAMPLE91.DIR  A sample master directory file (Jan-Feb 1991).
  188.                     Used to create initial sub-files for members.
  189.  
  190.            UPDATE.C91   A sample master directory file for March 1991
  191.                     only (used to create update sub-files for members).
  192.  
  193.  
  194.  
  195.        ┌─────┬──────────────────────────────────────────────────────────┐
  196.        │ 3.0 │░░░ OTHER STUFF ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  197.        └─────┴──────────────────────────────────────────────────────────┘
  198.  
  199.  
  200.        1)  The latest timing tests were run with a 386-33 on a freshly
  201.        defragmented hard drive (this helps a LOT!).
  202.  
  203.        BUFFERS & FILES     : 40
  204.        FMS Directory Size  : 471,073 bytes
  205.        Number of Records   : 5607
  206.        Number of Categories: 30
  207.        Time Req'd (min:sec): 2:26
  208.  
  209.  
  210.        2)  The SPTFMS program checks your CONFIG.SYS file to determine
  211.        the number of buffers allocated.  If the QEMM Memory Manager is
  212.        present, then SPTFMS will also check the AUTOEXEC.BAT file.
  213.  
  214.        3)  SPTFMS requires free space on your drive to be equivalent to
  215.        double the total size all FMS master directory files being
  216.        processed.  Half of this space is used as temporary work space
  217.        (to protect your original file from nasties, like a power failure),
  218.        the remainder will be used by the sub-files being created.
  219.  
  220.  
  221.  
  222.        ┌─────┬──────────────────────────────────────────────────────────┐
  223.        │ 4.0 │░░░ HOW TO CONTACT US ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  224.        └─────┴──────────────────────────────────────────────────────────┘
  225.  
  226.  
  227.          The latest versions of the software are currently available from
  228.        SYS-COM BBS.
  229.          We've been testing & using this software at SYS-COM BBS since
  230.        Decmber 1991 and it appears that all the "quirks" (undocumented
  231.        features) have been worked out.  If you have any comments, reports
  232.        about bugs, enhancements, etc.,  you can contact the author in the
  233.        following ways:
  234.  
  235.  
  236.        CompuServe :  Rob Chandler   72537,1065
  237.                      (I usually check for mail once a week, leaving a
  238.                      message on Sys-Com is preferred)
  239.  
  240.        SYS-COM BBS: (807) 768-1255 (USR Dual Standard)
  241.                     (807) 768-0014
  242.                     (807) 767-7945 (SysOp: Dan Fiorito, evenings & weekends)
  243.                     Leave comment addressed to SYSOP, or E-MAIL to me.
  244.  
  245.  
  246.  
  247.        Mail:  Rob Chandler
  248.               615 Vickers St South   (South IS important, there's a north)
  249.               Thunder Bay, Ontario
  250.               P7E 1K2
  251.               Canada
  252.  
  253.