home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / BEEHIVE / ZCAT / NCAT.LBR / NCAT371.DQC / NCAT371.DOC
Text File  |  2000-06-30  |  9KB  |  205 lines
  1. DOCUMENTATION FOR:  NCAT.ASM         v3.71   03/14/84
  2.  
  3.  
  4.         NCAT is a catalog maintenance program.  It gets the directory
  5. from each disk processed and adds it to a MAST.CAT file.  If any new
  6. programs have been added (or deleted) since the last time the disk was
  7. processed, MAST.CAT is upgraded accordingly.  This enables the user to
  8. keep an accurate and current catalog listing.
  9.  
  10.         This program combines the original FMAP, QCAT and UCAT programs
  11. written by Ward Christensen some years ago.  NCAT was chosen as a new
  12. name so it would fit into the COMPUSERVE (MICRONET) phone system along
  13. with the current revision number.  (That system limits the file name
  14. plus the revision number to a maximum of six characters.)  NCAT has
  15. several useful enhancements:
  16.  
  17.  
  18.    1)  Self-determines maximum user space and resets the buffer lengths
  19.           automatically.
  20.  
  21.    2)  Allows the user to set the optimum directory buffer length for
  22.           his disk system without editing and reassembling.  Some disk
  23.           directories allow only 64 file names (896 bytes) while some
  24.           Winchester systems allow 1024 files names (14k).  Default is
  25.           currently set to 256.  If inadequate, a message informs the
  26.           user that he should reset the buffer size.  The value of the
  27.           maximum number of file names (including library members) is
  28.           stored in a word (two bytes) at the beginning of the program
  29.           just after the text string "MAX FILES =".  It can be patched
  30.           using DDT or DU.
  31.  
  32.    3)  Can abort easily whenever an answer is expected, via CTL-C or
  33.       CTL-X.
  34.  
  35.    4)  Can show the user area each disk file is on, if USER is set
  36.           YES.  Set at default to YES in present source code.  The user
  37.           number is listed after the volume number in MAST.CAT.  All
  38.           32 user areas are included.  Users 0 to 9 are indicated by the
  39.           appropriate digit; users from 10 to 31 are indicated by the
  40.           letters from A to V.
  41.  
  42.    5)  Displays the disk ID number for the disk being processed.
  43.  
  44.    6)  Allows the user to process Library directory entries as if
  45.       they were files.  MAST.CAT indicates that an entry is a
  46.           library member by substituting "<" for ";" as the
  47.           separator between the volume number and the user area.
  48.           Since the library cataloguing may not work without user
  49.           area storage anyway, this option is selected using the
  50.           same USER equate.
  51.     
  52.  
  53. *   *   *   *   *   *   *   *   *   *   *   *   *   *   *   *   *   *
  54.  
  55. NOTE:  Do not mix single density and double density disks while making
  56.        a catalog.  The NCAT program handles both, ok, but not at the
  57.        same time.  Terminate with an "N" and log in the new density disk
  58.        via CTL-C then run only disks with that density until you repeat
  59.        the procedure for a different disk density.  This was done since
  60.        most users only use one density for all disks.  It saves consid-
  61.        erable time (not to mention unnecessary wear on the disk drives)
  62.        not to have it automatically reboot with each new disk.
  63.  
  64. NOTE ON LIBRARIES:  NCAT assumes that any file with type "LBR" is a
  65.     library.  It checks that the file has space allocated to it,
  66.     and then checks the directory for reasonableness.  There is
  67.     no way that these tests can detect every case in which a user
  68.     has set up a non-library file with type LBR.  Anything which
  69.     gets through will cause garbage file names to be stored in
  70.     MAST.CAT.  NCAT then checks to see if the library appears to
  71.     have been written by LU version 3.00 or later and, if so, 
  72.     performs CRC checking on the directory.  This test cannot be
  73.     100% accurate either, and you may occaisionally get an
  74.     erroneous CRC error message with a library that does not in
  75.     fact contain CRC checking.  In this case, respond "Y" to
  76.     the "proceed anyway" query.
  77.  
  78. *   *   *   *   *   *   *   *   *   *   *   *   *   *   *   *   *   *
  79.  
  80.  
  81.  
  82.                    USING THE PROGRAM "FIRST TIME"
  83.  
  84.  
  85. 1)  Use your editor to make a MAST.CAT "starter file", with programs
  86.     you don't want listed since you have many of those.  For instance:
  87.  
  88.  
  89.         (CONFIG.COM           (note left parenthesis for first entry)
  90.         COPY.COM
  91.         DDT.COM
  92.         DUMP.COM
  93.         PIP.COM)              (note right parenthesis for last entry)
  94.         
  95.  
  96.         NOTE:  The first thing NCAT expects to see in this list is a
  97.                left parenthesis, so make sure there are no blank lines
  98.                at the start.  The last thing NCAT expects to see is a
  99.                right parenthesis followed by a "RET".  There should be
  100.                no additional blank lines.
  101.  
  102.                
  103.         (If you want to catalog ALL files, you still must have the
  104.         left and right parentheses as shown below.)
  105.         
  106.         ()            (with a RET following)
  107.  
  108.  
  109. 2)  Each disk to be cataloged requires a unique number for a file type.
  110.     It needs to be preceeded with a "-" to be recognized by NCAT as a
  111.     "special file name".  Example:
  112.         
  113.  
  114.         SAVE 0 B:-.033 
  115.  
  116.  
  117. 3)  Put disk with catalog programs into drive A:
  118.  
  119.         NCAT    .COM
  120.         XCAT    .COM
  121.         MAST    .CAT
  122.          
  123. 4)  Put disk to be cataloged into drive B:  and type:
  124.  
  125.         A>NCAT B:
  126.         
  127.     then answer the questions.  
  128.   
  129.  
  130.         NOTE:  A "Y", "RET" or "SPACE" are all suitable "yes" answers.
  131.  
  132.  
  133. 5)  Place the next disk to be cataloged into drive B:   Repeat as needed
  134.     until all desired disks have been processed.  At that time you may
  135.     wish to catalog the main disk itself.  In that case just say:
  136.  
  137.         A>NCAT
  138.  
  139.     and again answer the questions.  (This method is also used for one-
  140.     drive cataloging.)
  141.  
  142.  
  143.         NOTE:  A special feature allows the main disk to be placed in
  144.                any convenient drive.  If used in C: drive for example
  145.                you could insert the various disks one at a time into
  146.                the A: drive by using:
  147.  
  148.         C>NCAT A:
  149.  
  150.                When using the main disk in a drive other than A:  you
  151.                would need "some disk" in A: for warm reboot purposes.
  152.  
  153.  
  154.         NOTE:  Another way to handle the above situation is as follows.
  155.                If NCAT is on drive A:, MAST.CAT on drive C:, and the
  156.                disk to be catalogued on drive B:, then use
  157.  
  158.         A>NCAT B: C:
  159.  
  160.  
  161. 6)  Printing the file.  A companion program called XCAT automatically
  162.     makes a new cross-referenced file called MAST.LST.  This file can
  163.     be placed on disk, or directly sent to the printer.  An option
  164.     allows use of either fanfold or roll paper.  (If using roll paper,
  165.     it puts tear tabs each 11 inches.)  This program also permits the
  166.     user to select up to 9 extra spaces at the beginning of each line
  167.     to fake a new left margin.  (Some printers do not have adjustable
  168.     margins.)  The user may also select the starting and stopping pages
  169.     in case only part of the catalog is to be printed.
  170.  
  171.  
  172. ADDENDUM:
  173. --------
  174.  
  175.         Some users like to add an unique volume name to each disk.
  176.     Here is a suggstion for doing this:
  177.  
  178.  
  179.         A>SAVE 0 B:-.123              (volume ID in file type field)
  180.         A>SAVE 0 B:-07SEP82           (volume date in file name field)
  181.         A>SAVE 0 B:-EDITORS           (volume name in file name field)
  182.  
  183.  
  184.         All three can be placed on the same disk.  Since the first has
  185.     nothing prior to the file type area, it takes precedence and is con-
  186.     sidered the "volume ID number". None of them takes up any disk space
  187.     although they do reduce the total number of available directory file
  188.     names slightly.  These names would be displayed first on any special
  189.     alphabetical directory listing such as "DIRR", "XDIR", etc.
  190.         Adding a special disk name ahead of the volume number is possible
  191.     but can foul up the proper cross-reference listing with XCAT.  Since
  192.     you can have up to 1000 different disk numbers with no disk name, you
  193.     can actually keep far better track of your disks if you do NOT give
  194.     them a name.  That way you can keep them neatly numbered, 10 to a
  195.     box, and quickly and easily find the appropriate box, while with a
  196.     name it could become awkward to quickly locate a disk, or to invent
  197.     yet another suitable name when you get a goodly number of disks.
  198.  
  199.  
  200.  
  201.                                          Irvin M. Hoff
  202.                                          Los Altos Hills, CA  94022
  203.  
  204. (some modifications by Jay Sage)
  205.