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 / MBUG / MBUG004.ARC / CATM1.DQC / CATM1.DOC
Text File  |  1979-12-31  |  11KB  |  297 lines
  1. CATM.DOC                                  by  D.DUNFORD &  R. PREECE.
  2.  
  3. CATM.COM is the merging of Ward Christensen's catalogue system into a MENU
  4. driven program.  This gives the user an environment in which all catalogue
  5. housekeeping chores can be carried out with ease.
  6.  
  7. In particular the files ...
  8.      CAT.COM     - Displays the contents of MAST.CAT (CATALOGUE) 
  9.      NEWCAT.COM  - Catalogues disks using the MAST.CAT file
  10.     ... make up the core of the progam.
  11.  
  12. NOTE :-  NEWCAT.COM is a merging of FMAP.COM and UCAT.COM which were Ward's
  13. original update programs.  Unfortunately the author of NEWCAT.COM is unknown
  14. to us so we are unable to acknowledge him/her here.
  15.  
  16. To make CATM.COM independent we have added 7 new features:
  17.  
  18. CREATE MAST.CAT    -Creates MAST.CAT in the desired format.
  19. (IGNORE) A FILE    -Adds or Deletes Ignored Filenames to MAST.CAT.
  20. LABEL A DISK       -Adds or Deletes disk Labels.
  21. DELETE A DISK      -Deletes an entire disk's entries from MAST.CAT.
  22. DISPLAY MAST.CAT   -Displays the contents of MAST.CAT optionally on the
  23.              printer or screen.
  24. CP/M DIRECTORY     -CP/M disk directory of any specified drive.
  25. DELETE A FILE      -Delete disk files from within CATM.   
  26.  
  27. These are explained in more detail below. 
  28.  
  29. The system is still compatible with the existing system so relabelling of
  30. disks or updating of the MAST.CAT file will not be necessary for those of
  31. you already set up.
  32.  
  33.     ==============================================================
  34.  
  35. MAST.CAT  -  the master catalogue file.
  36.  
  37. The catalogue system uses the MAST.CAT file as it's catalogue.  This file
  38. can initially be created by the CATM program using menu option '0'.  As
  39. stated earlier,  the previous versions of this catalogue system uses the
  40. same format for the MAST.CAT file and is completely compatible.  The format
  41. for MAST.CAT is described here....
  42.  
  43. First is a list (in UPPER CASE !!) of names of files to be ignored by the
  44. cataloguing process.  This list is enclosed in parentheses and each name in
  45. the list is separated from the others by the bytes 0DH,0AH e.g.
  46.      (ASM.COM
  47.      DDT.COM
  48.      LOAD.COM
  49.      PIP.COM
  50.      SID.COM
  51.      STAT.COM
  52.      SUBMIT.COM)
  53.  
  54. NOTE :-  If no names are included in this list CATM.COM still requires the
  55. two parentheses to operate, i.e. ().
  56.  
  57. The rest of the file is dedicated to a list of catalogued files, with their
  58. relevant disk's label (separated by a comma),
  59. i.e.    FILENAME.TYP,DISKLBL.NUM
  60.  
  61. e.g.    ALLOC.COM,SYSRES.802
  62.  
  63. These entries are separated from each other by the bytes 0AH,0DH.
  64.  
  65.     ==============================================================
  66.  
  67. USING CATM.COM  
  68.  
  69. The functions of CATM.COM are treated here in menu sequence.
  70. The menu looks like this :-
  71.  
  72.                <<<<  CATALOGUE MENU  >>>>
  73.                CR-Escape  ^X-Menu  ^C-Exit
  74.  
  75.      0 - Create MAST.CAT      4 - Delete a Disk
  76.      1 - (Ignore) a file      5 - Display MAST.CAT
  77.      2 - Label a Disk         6 - CPM / DIRectory
  78.      3 - Catalogue a Disk     7 - DELETE a file
  79.  
  80. -
  81.  
  82. Any of the functions may be invoked at the '-' prompt level simply by typing
  83. the appropriate number.
  84.  
  85.     ==============================================================
  86.  
  87. 0 = CREATE MAST.CAT
  88.  
  89. Create a master catalogue file MAST.CAT containing a set of closed
  90. parentheses '()'.  This is the required format of the MAST.CAT file.  From
  91. this point on MAST.CAT is assumed to be in the 'A:' drive.
  92.  
  93. SAMPLE RUN
  94.  
  95. -0                  ;Type '0' at menu mode
  96. MAST.CAT Created    ;Message from CATM.
  97. -                   ;CATM then returns to menu selection mode.
  98.                     
  99.     ==============================================================
  100.  
  101. 1 = (IGNORE) A FILE.
  102.  
  103. Prints the list of filenames which are to be excluded from the catalogue,
  104. then allows the user to update the list by either adding or deleting
  105. filenames.  NB: All names must be in UPPERCASE !!
  106.  
  107. SAMPLE RUN
  108.  
  109. -1                    ;Type 1 at menu mode.
  110. (IGNORE FILES when cataloguing)     ;1st time through no filenames exist.
  111. Filename.typ          ;CATM prompts for input
  112. XDIR.COM              ;Filename input.  A <CR> at this point will cause CATM
  113.               ; to return to menu mode.
  114. A-Add  D-Delete       ;CATM'S prompt.
  115. A                     ;Adds (XDIR.COM) to the list.
  116. -                     ;CATM returns to menu mode.
  117.  
  118. Now any cataloguing of disks will ignore the file 'XDIR.COM'.  If an entry
  119. for this file exists in MAST.CAT already, it will be deleted when the
  120. relevant disk is updated.
  121.  
  122.     ==============================================================
  123.  
  124. 2 = LABEL A DISK.
  125.  
  126. Allows creation or deletion of a disk label for a disk in any of the
  127. currently active drives.  The labels are of the form ...
  128.  
  129.      -DISKLBL.NUM
  130.  
  131.     ... where    DISKLBL is a 7 character label of the disk, and
  132.             NUM     is 3 characters describing the disk.
  133.  
  134. These labels are actually files containing 0 kb.  These cannot be created
  135. easily under CP/M 3 on the Os-Ex, since there is no 'SAVE 0 ufn.typ' command
  136. as with CP/M 2.2.  The "-" is added by CATM, so the user need only consider
  137. the label text.  Note that labels may be created in UPPER or lower case.
  138.  
  139. SAMPLE RUN
  140.  
  141. -2                    ;type 2 at menu prompt.
  142. D:Disklbl.Num         ;CATM prompts for input.
  143. B:TEST.001            ;User input.  A <CR> at this point will cause CATM to
  144.               ; return to menu mode.
  145. A-Add  D-Delete       ;CATM asks if the label is to be added or deleted.
  146. A                     ;The answer here is 'A' for add.   
  147. -                     ;The label '-TEST.001' is now added to the disk in the
  148.               ; 'B' drive and CATM returns to menu mode.
  149.  
  150.     ==============================================================
  151.  
  152. 3 = CATALOGUE A DISK.
  153.  
  154. Adapted from NEWCAT.COM; processes the directory area of a disk and from
  155. this, updates the list of filenames in MAST.CAT.  Any new files will be
  156. added, any erased files will be deleted, and files in the (ignore) list will
  157. be ignored.  A special entry is kept indicating the amount of free space
  158. left on the disk.  When an update is completed CATM informs the user of the
  159. number of entries in MAST.CAT and prompts for further updates.
  160.  
  161. SAMPLE RUN
  162.  
  163. -3                    ;type 3 at menu mode.
  164.  
  165. Drive for DISK TO BE CATALOGUED : B
  166. Drive for CATALOGUE SYSTEM DISK : A
  167.  
  168.     ;CATM asks for the drives to be used during this update.
  169.     ;Here the 'A' & 'B' are inputs.
  170.  
  171. Place the DISK TO BE CATALOGUED in drive B: Press <RET> 
  172. Place the CATALOGUE SYSTEM DISK in drive A: Press <RET> 
  173.  
  174. DEL: +++20k.FRE       ;CATM informs the user of any changes
  175. ADD: +++25k.FRE       ;since the last update.
  176. ADD: GRAPH.COM
  177. DEL: G.MAC
  178.  
  179. MAST.CAT now has  215 files.
  180. Another disk to catalogue (Y/N) N
  181. -
  182.  
  183. CATM shows the disk now contains an extra 5k of free space and that 1 file
  184. has been added to the disk while another has been erased.
  185. The 'N' at the last prompt returns CATM to menu mode.
  186.  
  187.     ==============================================================
  188.  
  189. 4 = DELETE A DISK.
  190.  
  191. Allows the user to delete all catalogue entries for a particular disk. 
  192. Useful when disks get old or damaged and are no longer servicable.
  193. The update is done in one operation.
  194.  
  195. SAMPLE RUN
  196.  
  197. -4
  198. Disklbl.Num          ;CATM prompts for the disk
  199. CPM--22.008          ;The disk is CPM--22.008
  200.  
  201. DEL: +++24k.FRE
  202. DEL: ASM.COM          ;CATM informs the user of deletions made
  203. DEL: COPY.COM
  204. DEL: COPYSYS.COM
  205. DEL: DDT.COM
  206. DEL: DIR.COM
  207. DEL: DUMP.COM
  208. DEL: LOAD.COM
  209. DEL: FORMAT.COM
  210. DEL: SUBMIT.COM
  211. DEL: XDIR.COM
  212.  
  213. MAST.CAT now has 240 files.
  214.  
  215. -               ;CATM returns to main menu.
  216.  
  217. At this point any entry associated with the disk 'CPM--22.008' has been
  218. deleted.
  219.  
  220.     ==============================================================
  221.  
  222. 5 = DISPLAY MAST.CAT
  223.  
  224. Adapted from CAT.COM, displays the contents of MAST.CAT to either the screen
  225. or the printer.  It will accept ambiguous filerefs or disk labels and can be
  226. used to display according to either files or disks.  Scrolling stops when
  227. the screen is full and the user is prompted to continue.  Comments may also
  228. be added and are included in the page heading.
  229.  
  230. SAMPLE RUN
  231.  
  232. -5
  233. Printer or Screen ? P/S S         ;Input Prompt.  Answer S for sceen output.
  234. ? and * Wildcards  *.* = All Filename.Typ 
  235. Disklbl.Num  COMMENTS            ;Input Prompts.
  236. WS.COM *.*  as at 10/03/80
  237.     ;here the user is asking for all references to WS.COM on any disk and
  238.     ;putting the date in the page heading.
  239.  
  240. FILES :- WS.COM *.*  as at 10/03/80
  241.      NAME           DISK               NAME           DISK       
  242.  
  243.  WS      .COM    WS-DOC1.001       WS      .COM    WS-TXT1.004      
  244.  WS      .COM    WS-TXT2.005       WS      .COM    WS-TXT3.017
  245.  
  246. -   ;in this case 4 entries for WS.COM exist, so CATM returns to menu mode.
  247.  
  248. SUMMARY OF COMMANDS FOR OPTION 4.
  249.  
  250. At the prompt in option 4 the user may specify exactly the type of listing
  251. required:-
  252.  
  253. <CR>                    - escapes to menu mode. 
  254. SPACE <CR>              - lists the entire catalog.
  255. *.*                     - lists the entire catalog. 
  256. *.* WORK.*              - lists all files on any "WORK" disk.
  257. *.* *.002               - lists all entries for disk .002.
  258. *.ASM                   - lists entries for all .ASM files
  259. A*.*                    - lists all files starting with an 'A'
  260. *.* *.??1               - lists all files on disks with serial numbers xx1.
  261. *.BAS WORK.*            - lists all '.BAS' files found on any 'WORK' disk.
  262.  
  263.     ==============================================================
  264.  
  265. 6 = CP/M DIRECTORY
  266.  
  267. A standard CP/M directory, handy when updating disk labels or cataloguing.
  268. Allows any active drive to be specified.
  269.  
  270. SAMPLE RUN
  271.  
  272. -6                       ;type 7 at menu prompt.
  273. Which Drive ? B          ;CATM asks for the drive.
  274.  
  275.  -CATMWK .001 | CATM    .DOC | KEYS    .COM | SCRMBL  .COM
  276.  CATM    .BAK | CATM    .MAC | KEYS    .MAC | XDIR    .COM
  277.  CATM    .COM | CPM3    .SYS | TXTL    .COM |
  278.  
  279. -   ;the directory for drive B: is given and CATM then returns to menu mode.
  280.  
  281.     ==============================================================
  282.  
  283. 7 = DELETE A FILE
  284.  
  285. Enables the user to delete files from a disk in any active drive, without
  286. going to CP/M level.  Ideal for erasing .BAK files before cataloguing the
  287. disk.
  288.  
  289. SAMPLE RUN
  290.  
  291. -7                                 ;type 7 at menu prompt.
  292. D:FILENAME.TYP                     ;Prompt for input.
  293. B:XDIR.COM                         ;Delete XDIR.COM from B:
  294.                                    ;<CR> will ret to menu mode.
  295. -                                  ;CATM returns to menu mode.
  296.                                  ;<CR> will ret to menu mode.
  297. -