home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpm / catlog / mcat45.lbr / MCAT.DQC / MCAT.DOC
Text File  |  1985-11-23  |  7KB  |  182 lines
  1.  
  2. DOCUMENTATION FOR:  MCAT.ASM  -  08/29/84
  3.  
  4.  
  5.     NOTE:   You may want to immediately change the
  6.         name to MCAT.COM and the companion pro-
  7.         gram to XCAT.COM, to facilitate use.
  8.  
  9.  
  10.         MCAT is a CP/M catalog maintenance program.  It gets the direc-
  11. tory from each disk processed and adds it to a MAST.CAT file.  If any
  12. new programs have been added (or deleted) since the last time the disk
  13. was processed, MAST.CAT is upgraded accordingly.  This enables the user
  14. to keep an accurate and current catalog listing.  It supports CP/M 3.0
  15. as well as CP/M 2.2, etc.
  16.  
  17.  
  18.         This program combines the original FMAP, QCAT and UCAT programs
  19. written by Ward Christensen some years ago.  MCAT was chosen as a new
  20. name so it would fit into the COMPUSERVE (MICRONET) network system along
  21. with the current revision number.  (That system limits the file name
  22. plus the revision number to a maximum of six characters.)  MCAT has sev-
  23. eral useful enhancements:
  24.  
  25.  
  26.    1)  Self-determines maximum user space on the sytem being currently
  27.       used and resets the buffer lengths automatically.
  28.  
  29.    2)  Allows the user (via MCAT.SET) to select the optimum directory
  30.           buffer length for his disk system without editing and reassem-
  31.           bling.  Some disk directories allow only 64 file names (896
  32.           bytes) while some Winchester systems allow 1024 files names
  33.           (14k).  Default is currently set to 256.  If inadequate, a
  34.           message informs the user he should reset the buffer size.
  35.  
  36.    3)  Can abort easily whenever an answer is expected, via CTL-C or
  37.       CTL-X.
  38.  
  39.    4)  Can show the user area each disk file is on, if USER is set
  40.           YES.  Set at default to NO for normal use.
  41.  
  42.    5)  Displays the disk ID number for the disk being processed.
  43.  
  44.     
  45.  
  46. *   *   *   *   *   *   *   *   *   *   *   *   *   *   *   *   *   *
  47.  
  48. NOTE:  You should be able to mix single density and double density disks
  49.        while making a catalog.  While MCAT resets the drive each time a
  50.        new disk is inserted, it might be better to separate the disks so
  51.        only one density would be run at a time.  When finished with that
  52.        group, hit "N" to terminate then place a disk taken from the next
  53.        group into the drive hit CTL-C to reboot and continue.  Depending
  54.        what type of disks you are mixing this extra work may not be nec-
  55.        essary.
  56.  
  57. *   *   *   *   *   *   *   *   *   *   *   *   *   *   *   *   *   *
  58.  
  59.  
  60.  
  61.                    USING THE PROGRAM "FIRST TIME"
  62.  
  63.  
  64. 1)  Use your editor to make a MAST.CAT "starter file", with programs
  65.     you don't want listed since you have many of those.  For instance:
  66.  
  67.  
  68.         (CONFIG.COM           (note left parenthesis for first entry)
  69.         COPY.COM
  70.         DDT.COM
  71.         DUMP.COM
  72.         PIP.COM)              (note right parenthesis for last entry)
  73.         
  74.  
  75.         NOTE:  The first thing MCAT expects to see in this list is a
  76.                left parenthesis, so make sure there are no blank lines
  77.                at the start.  The last thing MCAT expects to see is a
  78.                right parenthesis followed by a "RET".  There should be
  79.                no additional blank lines.
  80.  
  81.                
  82.         (If you want to catalog  a-l-l  files, you still must have one
  83.         "dummy file" to ignore.  You could use:)
  84.         
  85.         ()            (with a RET following))
  86.  
  87.  
  88. 2)  Each disk to be cataloged requires an unique number for a file type.
  89.     It needs to be preceeded with a "-" to be recognized by MCAT as a
  90.     "special file name".  Example:
  91.  
  92.     A>SAVE 0 -.123
  93.  
  94.         NOTE: FOR CP/M PLUS USERS - the SAVE command is not
  95.            used in the same way as in CP/M 2.2 and before.
  96.             You can not save a file with 0 bytes.  A spe-
  97.             cial program called NULL.ASM was written by
  98.           Guy Gamble that will allow easy naming of CP/M+
  99.           disks.  This is a necessary utility for using
  100.             this program with CP/M Plus.  (DU-V86 could be
  101.             used but requires extra work.)
  102.  
  103.  
  104. 3)  Put disk with catalog programs into drive A:
  105.  
  106.         MCAT    .COM
  107.         XCAT    .COM
  108.         MAST    .CAT
  109.          
  110. 4)  Put disk to be cataloged into drive B:  and type:
  111.  
  112.         A>MCAT B:
  113.         
  114.     then answer the questions.  
  115.   
  116.  
  117.         NOTE:  A "Y", "RET" or "SPACE" are all suitable "yes" answers.
  118.  
  119.  
  120. 5)  Place the next disk to be cataloged into drive B:   Repeat as needed
  121.     until all desired disks have been processed.  At that time you may
  122.     wish to catalog the main disk itself.  In that case just say:
  123.  
  124.         A>MCAT
  125.  
  126.     and again answer the questions.  (This method is also used for one-
  127.     drive cataloging.)
  128.  
  129.  
  130.         NOTE:  A special feature allows the main disk to be placed in
  131.                any convenient drive.  If used in C: drive for example
  132.                you could insert the various disks one at a time into
  133.                the A: drive by using:
  134.  
  135.         C>MCAT A:
  136.  
  137.                When using the main disk in a drive other than A:  you
  138.                would need "some disk" in A: for warm reboot purposes.
  139.  
  140.  
  141. 6)  Printing the file.  A companion program called XCAT automatically
  142.     makes a new cross-referenced file called MAST.LST.  This file can
  143.     be placed on disk, or directly sent to the printer.  An option
  144.     allows use of either fanfold or roll paper.  (If using roll paper,
  145.     it puts tear tabs each 11 inches.)  This program also permits the
  146.     user to select up to 9 extra spaces at the beginning of each line
  147.     to fake a new left margin.  (Some printers do not have adjustable
  148.     margins.)  The user may also select the starting and stopping pages
  149.     in case only part of the catalog is to be printed.
  150.  
  151.  
  152. ADDENDUM:
  153. --------
  154.  
  155.         Some users like to add an unique volume name to each disk.
  156.     Here is a suggstion for doing this:
  157.  
  158.  
  159.         A>SAVE 0 B:-.123              (volume ID in file type field)
  160.         A>SAVE 0 B:-07SEP82           (volume date in file name field)
  161.         A>SAVE 0 B:-EDITORS           (volume name in file name field)
  162.  
  163.  
  164.         All three can be placed on the same disk.  Since the first has
  165.     nothing prior to the file type area, it takes precedence and is con-
  166.     sidered the "volume ID number". None of them takes up any disk space
  167.     although they do reduce the total number of available directory file
  168.     names slightly.  These names would be displayed first on any special
  169.     alphabetical directory listing such as "DIRR", "XDIR", etc.
  170.         Adding a special disk name ahead of the volume number is possible
  171.     but can foul up the proper cross-reference listing with XCAT.  Since
  172.     you can have to up 999 different disk numbers with no disk name, you
  173.     can actually keep far better track of your disks if you do NOT give
  174.     them a name.  That way you can keep them neatly numbered, 10 to a
  175.     box, and quickly and easily find the appropriate box, while with a
  176.     name it could become awkward to quickly locate a disk, or to invent
  177.     yet another suitable name when you get a goodly number of disks.
  178.  
  179.  
  180.  
  181.                                          Irvin M. Hoff
  182.                                          Los Altos Hills, CA  94022