home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / mbug / mbug044.arc / CATALOG.DOC < prev    next >
Text File  |  1979-12-31  |  8KB  |  241 lines
  1.           DOCUMENTATION FOR MASTER CATALOG SYSTEM
  2.           ---------------------------------------
  3.  
  4. Last revised: 23-Apr-84
  5.               Ian Gillies, Malcolm Miles
  6.  
  7. INTRODUCTION
  8.  
  9. This document describes a system for cataloging  collections 
  10. of  CP/M  diskettes.   The  system  and  documentation  were 
  11. originally written by Ward Christensen.  The latest  updates 
  12. to  this system are available on TARDIS-RCPM on  03-67-7760. 
  13. Any  comments or suggestions please leave a message for  the 
  14. SYSOP.
  15.  
  16. The  master  cataloging  system consists  of  the  following 
  17. programs (current version numbers are listed):
  18.  
  19. MAST.CAT        The catalog itself 
  20.  
  21. FMAP.COM  V2.2      Used    to   create    NAMES.SUB,    the 
  22.                     "transaction file" for catalog update.
  23.       
  24. UCAT.COM  V2.2      The  update  program,  merges  NAMES.SUB 
  25.                     into MAST.CAT.
  26.  
  27. CAT.COM      V2.1      Catalog listing program.
  28.  
  29.  
  30. -----------------------------------------------------------
  31.  
  32. FIRST TIME
  33.  
  34. Before  running  the CATALOG system for the first  time  the 
  35. master   catalog  file  must  be  created  and  your   disks 
  36. serialized.  
  37.  
  38. First create MAST.CAT with the following format:
  39.  
  40. (filename.typ
  41. filename.typ
  42. filename.typ)
  43.  
  44. This  is  a  list  of  the filenames  that  are  not  to  be 
  45. catalogued  and usually includes system-type files that  are 
  46. on every disk. For example:
  47.  
  48.     (ASM.COM
  49.     DDT.COM
  50.     LOAD.COM
  51.     PIP.COM
  52.     STAT.COM
  53.     SUBMIT.COM)
  54.  
  55. The parenthesis pair must always be present even if no files 
  56. are to be ignored.
  57.  
  58. Each disk to be catalogued must be serialized.  This is done 
  59. by  having  a unique file on the disk to identify  it.  This 
  60. filename is in the format:
  61.  
  62.                     -filename.serial
  63.  
  64. for example:        -GAMES.002
  65.  
  66. The  filename  must  begin  with a '-' as it  is  this  that 
  67. ensures that it is listed first in a sorted disk  directory. 
  68. For  this reason you should ensure that no other files on  a 
  69. disk  have  a  filename starting with a '-'.  For  the  same 
  70. reason  you  should  never  have a file on  a  disk  with  a 
  71. filename  starting  with any character whose ASCII  code  is 
  72. less than a '-', for example, '+', '#', '%'.
  73.  
  74. You  may  create this file on your disk with a  simple  SAVE 
  75. command as follows:
  76.  
  77. SAVE 0 B:-GAMES.002
  78.  
  79. (NOTE: The SAP (sort and pack directory) program distributed 
  80. on  the  CP/M User Group library deletes all  0-length  file 
  81. entries,  so  if you use this utility or one similar to  it, 
  82. use SAVE 1, not SAVE 0.) 
  83.  
  84. ----------------------------------------------------------
  85.  
  86. HOW TO USE
  87.  
  88. Once you have created the MAST.CAT file and serialized  your 
  89. disks you can now run the CATALOG system proper. The easiest 
  90. way to run the CATALOG system is from a SUBMIT file.  Create 
  91. the file CAT.SUB with the following format:
  92.  
  93. FMAP B:*.*  FN
  94. UCAT 
  95.  
  96. To  catalog a disk mount the disk with MAST.CAT and  CAT.SUB 
  97. on  drive A and the disk to be catalogued on drive  B.  Then 
  98. type SUBMIT CAT. Change the disk in drive B and repeat until 
  99. all  disks have been catalogued.  (HINT:  change the name of 
  100. the SUBMIT program to @.COM to reduce the amount of typing.)
  101.  
  102. ------------------------------------------------------------
  103.  
  104. PROGRAM DETAILS
  105.  
  106. MAST.CAT  is the master catalog file.  It has the  following 
  107. format:
  108.  
  109. (ignore-file
  110. ignore-file
  111. ignore-file)
  112. filename.type,diskname.serial;user
  113.  
  114. For example:
  115.  
  116. (PIP.COM
  117. STAT.COM)
  118. FOO.ASM,WORK.002;1
  119. STARTREK.COM,GAMES.002;0
  120.  
  121. ----------------------------------------------------------
  122.  
  123. FMAP  is used to update the catalog for a  disk.  FMAP  does 
  124. this  by  creating a NAMES.SUB file which contains a  sorted 
  125. list of the files on the disk to be catalogued.
  126.  
  127. Submit  files  ($$$.SUB)  and temporary  files  (*.$$$)  are 
  128. automatically skipped.  FMAP also creates a dummy file entry 
  129. in  NAMES.SUB  file giving the amount of space left  on  the 
  130. disk.  This  dummy file creation can be disabled at  compile 
  131. time. The file entry is of the form:
  132.  
  133.      [ 999 ].LFT    where 999 is the amount (in K) remaining
  134.                     on the disk
  135.  
  136. If  you  run  FMAP without any parameters  a  full  list  of 
  137. options  and their use will be displayed.  FMAP can be  used 
  138. for a number of purposes but when using FMAP for cataloguing 
  139. the following command format should be followed (a parameter 
  140. is optional if in []):
  141.  
  142. FMAP [input drive:]*.* [output drive:]F[N]
  143.  
  144. If  no  drives are specified FMAP defaults  to  the  current 
  145. default drive.
  146.  
  147. If the N option is specified console listing is suppressed.
  148.  
  149. ---------------------------------------------------------
  150.  
  151. UCAT  is  used to merge the NAMES.SUB file created  by  FMAP 
  152. into the MAST.CAT file and then erase NAMES.SUB.
  153.  
  154. UCAT [-filename.serial]
  155.  
  156. The   optional   '-filename.serial'  parameter  allows   the 
  157. cataloguing  of  disks  that you do not  wish  to  create  a 
  158. '-filename.serial'  on (eg:  master disks).  This  parameter 
  159. will  also  override any '-filename.serial' already  on  the 
  160. disk to be catalogued. This is useful when cataloguing disks 
  161. which  may have a number of '-filename.serial' entries  (eg: 
  162. archive disks).
  163.  
  164. Note  that  UCAT is a "belts and suspenders"  type  program,  
  165. i.e:  it creates NEW.CAT, merges NAMES.SUB with MAST.CAT and 
  166. puts it into NEW.CAT and only then does it -
  167.  
  168.     era mast.bak
  169.     ren mast.bak=mast.cat
  170.     ren mast.cat=new.cat
  171.  
  172. This  means  that unless you era mast.bak,  there will be  3 
  173. copies  of  the  master  catalog on  the  disk  during  UCAT 
  174. execution. Because of this if you are pressed for disk space 
  175. you may have to erase MAST.BAK prior to running UCAT.
  176.  
  177. -------------------------------------------------------------
  178.  
  179. CAT formats and displays MAST.CAT to a screen or printer.
  180.  
  181. The format of CAT is:
  182.  
  183. CAT [filename.type] [diskname.serial] [title or comments]
  184.  
  185. All  parameters are optional.  If the filename is omitted  a 
  186. default filename of '*.*' is assumed. If the diskname.serial 
  187. is  omitted  then a default of all  disks  is  assumed.  The 
  188. wildcards  '*'  and '?' can be used in specifying  filenames 
  189. and disknames.
  190.  
  191. Examples: CAT                      all files
  192.           CAT *.* WORK.*           all files on any -WORK disk
  193.           CAT *.ASM                all .ASM files
  194.           CAT *.* *.* as at 11-Jan-84
  195.                                    displays title on each page
  196.  
  197. The   following features of CAT can be changed by  modifying  
  198. the  conditionals in the source file and re-compiling:  page  
  199. length,   page  pause,  page  numbering,  screen  width  and  
  200. omission of '-filenames' from output.
  201.  
  202. -----------------------------------------------------------
  203.  
  204. REMOVING DISKS FROM MAST.CAT
  205.  
  206. If you want to remove the entries for a catalogued disk from 
  207. MAST.CAT  you need to create a file called  NAMES.SUB  which 
  208. contains a single line:
  209.  
  210. -filename.serial 
  211.  
  212. where '-filename.serial' is the disk you wish deleted.  UCAT 
  213. is  then run normally and will remove all file  entries  for 
  214. that disk from MAST.CAT.
  215.  
  216. ------------------------------------------------------------
  217.  
  218. The  FIND  program (available on the TARDIS RCPM and in  the 
  219. CP/M  User Group  library) is  also  very useful  when  used 
  220. with  MAST.CAT.   Suppose   you have   the   following    in   
  221. MAST.CAT:
  222.  
  223.      BIOS1.ASM
  224.      BVIOS.ASM
  225.      CBIOS.ASM
  226.      M2BIOS.ASM
  227.  
  228. It's  obvious  that CAT cannot find all  your  BIOS  related 
  229. files but use FIND as follows:
  230.  
  231.      FIND MAST.CAT IOS  
  232.  
  233. and you will find them all.
  234.  
  235. -----------------------------------------------------------
  236.  
  237. End of documentation
  238. 23-Apr-84 Malcolm Miles
  239. ----------------------------------------------------------
  240.  
  241. REMOVING DISKS FROM MAST.CAT