home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / lambda / soundpot / a / cat.lbr / CATALOG.DZC / CATALOG.DOC
Encoding:
Text File  |  1993-10-26  |  8.0 KB  |  225 lines
  1. (THIS IS FILE CATALOG.DOC AS OF    3/13/78)
  2.  
  3. CP/M DISK CATALOGING SYSTEM FOR    COMPUTER HOBBYISTS
  4.         BY WARD    CHRISTENSEN
  5.  
  6.         -----OVERVIEW-----
  7.  
  8. I have always wanted to    be able    to keep    track of
  9. where files are    on my CP/M diskettes.  The first
  10. step was to make a 'DIR' listings with the printer on.
  11.  
  12. Next I wrote a command called 'MAP' which printed the
  13. disk extent information    also (but not any extent past
  14. the first).  Then I wrote 'SMAP' which produces    a sorted
  15. directory listing.  This made finding files in the listings
  16. easier.     At this time I    also adopted the convention of
  17. editing    a 'dummy' file on each disk, called '-DISK.nnn'
  18. where nnn is the disk's    serial number.    Later I    changed
  19. the word 'DISK'    to any more meaningful name, such as
  20. '-WORK.023' or '-CBIOS.019', etc.  The important
  21. thing was that each started with a '-' which meant it
  22. would sort to the top of the sorted listing.
  23.  
  24. Eventually, I wrote 'FMAP' which creates a sorted
  25. directory listing, but also, if    'FMAP *.* F' is    typed,
  26. writes 'NAMES.SUB' to disk with    the names of all the
  27. files on the disk.
  28.  
  29. This file of names then    got me thinking    about having
  30. a master file of names,    or a 'master catalog'.
  31.  
  32. That is    what I did.  I now have    1 disk file which
  33. contains the file names    and disk names for every
  34. pertinent file I have.    I also wrote a command
  35. which behaves like 'DIR' but scans the master catalog.
  36.  
  37.         -----PROGRAMS-----
  38.  
  39. UCAT.ASM/COM  Maintains    'MAST.CAT'
  40.  
  41. CAT.ASM/COM   Allows 'DIR' search of 'MAST.CAT'
  42.  
  43. FMAP.ASM      Creates a    file of    the names on a diskette
  44.           as input to 'UCAT.COM' along with    'MAST.CAT'
  45.  
  46.  
  47.     -----INSTALLING    THE CATALOGING SYSTEM-----
  48.  
  49. 1)    Edit 'MAST.CAT'    in order to place entries
  50. in it for the file names you don't want    to be placed in
  51. the catalog.  I    already    have ASM.COM, STAT.COM,    PIP.COM,
  52. and others in the sample MAST.CAT.  Since these    are on nearly
  53. every disk, I therefore    don't want them    to take    room in    the
  54. catalog.  N-O-T-E you don't have to edit the file -
  55. you may    type it    and decide to take my defaults.
  56. NOTE The format    of the 'empty' MAST.CAT    is simply
  57. a list of names    which you don't    want put in the    catalog.
  58. This may be 1 or more file names.  It cannot be    zero names.
  59. If you want everything cataloged, put a    name such as
  60. 'DUMMY.FIL' in the catalog.  The format    is as follows:
  61. Each name is on    a separate line.  The first name is pre-
  62. ceeded by a '('.  The last is followed by ')'. thus:
  63. (ASM.COM
  64. PIP.COM
  65. STAT.COM)
  66.  
  67. 2)    Pick a disk which will contain the master
  68. catalog    'MAST.CAT'.  You m-u-s-t serial    number (3 digits)
  69. all your diskettes, placing a file '-anyname.nnn' on
  70. each disk.  The    UCAT routine then takes    this as    the name
  71. of the disk.
  72.  
  73. 3)    Put the    following files    on this    master disk:
  74.     MAST.CAT
  75.     FMAP.COM
  76.     UCAT.COM
  77.     CAT.COM
  78.     -anyname.nnn
  79.  
  80.  
  81.  
  82. 4)    Type: FMAP A: Q      (FMAP    ON THIS    DISK DOES NOT ACCEPT THIS)
  83.  
  84. This will creates NAMES.SUB, which has the names of
  85. the files on this disk.     The 'q' means to write    the file
  86. to disk    'quietly'.  If you want    to see the listing, type:
  87.  
  88.     FMAP A:    F  (USE    THIS WITH THE FMAP ON THIS DISK)
  89.  
  90. Which will write the file, but also print the sorted
  91. directory listing.
  92.  
  93. 5)    Type: UCAT
  94. This will merge    the file names in 'NAMES.SUB' (created by
  95. FMAP) with the names in    MAST.CAT.  It will report the names
  96. of any files which are added to, or deleted from, the
  97. catalog.
  98.  
  99.     -----USING THE CATALOGING SYSTEM-----
  100.  
  101. 1)    Whenever you put a new diskette    into service
  102. you must place a '-anyname.nnn'    entry in the directory.
  103. nnn should be the disk's unique    serial number.    The easiest
  104. way to place an    entry in the directory,    with 0 data as-
  105. sociated with it is to 'ED -anyname.nnn' then when
  106. 'NEW FILE' types, type control-c.  This    will leave the
  107. entry in the catalog, but will not take    any data space.
  108. Then type:ERA *.$$$ (or    ERA B:*.$$$) to    erase the temporary
  109. file which was created by the editor.
  110.  
  111. 2)    Assuming the disk with the catalog programs is
  112. on drive a, whenever you want to catalog the disk on
  113. drive b, type:
  114.     FMAP B:    Q
  115.  then type:
  116.     UCAT
  117. This results in    the disk being added to    the catalog. 
  118. This can be done whenever you want, as the entries for the
  119. disk are deleted from MAST.CAT and the new ones    added. 
  120. This means the cataloging system properly keeps    track of
  121. erased files also (i.e.    erases them from the catalog when
  122. it no longer finds them    on the disk being cataloged). If
  123. you want to re-catalog the 'A' disk, type:
  124.     FMAP A:    Q
  125. then type:
  126.     UCAT
  127.  
  128. 3)    Use the    'CAT' command to scan the catalog
  129. as you use 'DIR' to scan the directory of the current
  130. disk.  The operands of 'CAT' are just like 'DIR' except
  131. that there is a    second filename.type - namely the disk's name
  132. and serial.  N-O-T-E that UCAT deletes the leading '-'
  133. when it    places a disk name in the directory.  Therefore
  134. you don't use the '-' when asking for a    particular disk.
  135.  
  136.  
  137. Examples of 'CAT' command requests:
  138.  
  139. CAT            lists entire catalog
  140. CAT *.*    *.002        lists entries for disk 002
  141. CAT *.asm        lists all asm files
  142. CAT A*.*        lists all files    starting with 'A'
  143. CAT *.BAS WORK.*    lists all 'BAS'    files on any
  144.             disk with name 'WORK' (any serial)
  145.  
  146. Note that what you type    following the CAT command appears
  147. as the title of    the resultant listing.    This is    particularly
  148. useful for keeping hard    copy listings of your catalog, such
  149. as by typing:
  150.  
  151.     CAT *.*    *.* AS OF 02/17/78
  152.  
  153. this will result in the    title:
  154.  
  155.     FILES: *.* *.* AS OF 12/17/77
  156.  
  157. appearing on each page of the catalog listing.
  158.  
  159. 4)    If you want to erase something from MAST.CAT
  160. you do so by erasing the file from the diskette    it is
  161. on, then cataloging that disk.    If you crash a disk and
  162. want to    erase all it's entries from the    catalog, you have
  163. to edit    a dummy    'NAMES.SUB' with just the disk name in it,
  164. then execute 'UCAT' which will be faked    into thinking you
  165. are cataloging an empty    disk.  This will cause all entries
  166. for the    disk to    be erased.
  167.  
  168.         EXAMPLE:
  169. Suppose    disk '-WORK.023' crashed, and you want to delete
  170. all references to it from MAST.CAT.  (you might    first want
  171. to do 'CAT *.* *.023 to    see what was lost).  Edit NAMES.SUB
  172. and place the following    single line in it:
  173. -WORK.023
  174. then run UCAT.    This will result in all    files referring    to
  175. -WORK.023 being    erased.
  176.  
  177. -------------------------------------------------
  178.         N O T E    S
  179. -------------------------------------------------
  180.  
  181. The UCAT program creates a file    'NEW.CAT', and ONLY
  182. when the update    appears    to be successful, does it do
  183. the following functions    internally:
  184.  
  185.     ERA MAST.BAK
  186.     REN MAST.BAK=MAST.CAT
  187.     REN MAST.CAT=NEW.CAT
  188.  
  189. Thus, there are    3 versions of the catalog on your disk at
  190. one time:  MAST.BAK, MAST.CAT, AND NEW.CAT, so if your disk
  191. is low on space, you may sacrifice this    integrity, and manually
  192. ERA MAST.BAK before running UCAT.  The program could
  193. also be    modified, to do    the erase first.
  194.  
  195.  
  196.  
  197.  
  198. -------------------------------------------------
  199. -------------------------------------------------
  200.  
  201.  
  202. QCAT was submitted subsequently, with the following comments:
  203.  
  204. QCAT allows cataloging disks on    a 1 disk system.
  205. You type QCAT, and the program asks you    to mount the
  206. disk to    be cataloged, and press    a D.  You do so.  It
  207. then tells you to mount    the catalog disk, and press return.
  208. You do that.  This causes a "NAMES.SUB"    file to    be written
  209. to the catalog disk.  Type: UCAT which will then execute the
  210. catalog    updating program, which    alphabetically merges
  211. NAMES.SUB with the file    MAST.CAT, then erases the NAMES.SUB
  212. file.
  213.  
  214. NOTE that each disk to be cataloged must have a    file
  215. "-diskname.serial" (such as "-MAC.005").  When the list
  216. of names on the    disk is    sorted,    the leading "-"    on this
  217. filename causes    it to be sorted    first.    It is then taken
  218. as the disk name and serial, and is written to the master
  219. catalog    next to    each filename on the disk.
  220.  
  221. You are    referred to the    previous documentation on the
  222. cataloging system for more details.
  223.  
  224. ------
  225.