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 / ZSUS / Z3HELP-3.LBR / M.LBR / MCAT.HZP / MCAT.HLP
Text File  |  2000-06-30  |  12KB  |  218 lines
  1. ;
  2.                                    MCAT.COM                                   
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5.               13k (97)   0E2A  6.0g       Hal Bower 2/89           Z3COM6
  6.  
  7.   1- Syntax  2- Operation  3- Configuration  4- Notes  5- Examples of Use     
  8.  
  9.    MCAT and its companion program, XCAT, form a powerful system for cataloging
  10. and accessing a data base of files and disks.   With the addition of  a single 
  11. file name on a disk, the entire contents of the disk directory, and members of
  12. Library files, may be captured for later retrieval.   MCAT builds and modifies 
  13. the data base while XCAT permits customized queries of the contents.
  14.  
  15. Version 6 expands date support  to include  ZSDOS and CP/M Plus  type of Date/
  16. Time stamps, as  well as  providing  automatic support  for  ZCPR3 environment 
  17. features  such  as  screen  addressing  and  attributes,  and  named directory 
  18. support.  No installation is necessary under any ZCPR version 3.0 or later.
  19. :1
  20.  
  21.  
  22.    Syntax   MCAT<cr>            <-- Enter interactive mode
  23.         MCAT [options]      <-- Immediate execution
  24.  
  25.   Options   $[d]                <-- add dates[d]
  26.         <[d]                <-- catalog drive D:
  27.         >[d][u]             <-- MAST.CAT on DU:
  28. :2
  29.  
  30.  MCAT Operation 
  31.  
  32.    MCAT can operate in either  an interactive mode for  repetitive operations,
  33. or in a command line driven  mode for  a single catalog operation.   If errors 
  34. are detected during execution, operation will  revert to  the interactive mode 
  35. for correction and optional re-execution.  This "expert" mode is automatically
  36. set if command line arguments are detected.   When executed  from either mode,  
  37. the screen  will  be  cleared  if  running  under ZCPR3 and  a  header will be 
  38. displayed  on  the upper few lines of  the  display.   If no ZCPR3  Termcap is 
  39. detected, the  information will  be scrolled  up  the screen  from the present 
  40. cursor position.  
  41.  
  42.    Following is  a sample of  the initial  screen information.   Note that the 
  43. lines listed  on the screen  before the  prompt  line  concerning  alternately  
  44. placing disks on the drive will only be shown if the drive being cataloged and
  45. the drive declared as  holding the catalog are the same.   This will rarely be 
  46. the case in multi-drive systems, but the  added warning and prompts  are handy 
  47. when needed to reduce the chance of errors.
  48.  
  49. +------------------------------------------------------------------------------+
  50. |MCAT Cataloger  V6.0f (ZSDOS/DateStamper)               05 Feb 1989  08:59:29 |
  51. | ^Log MAST.CAT : C8                     ^Drive to Add : C                     |
  52. | ^Format : Users Dates                  ^Remove Volume                        |
  53. | ^Initialize Catalog                                                          |
  54. | ^Z - Redraw Screen                                                           |
  55. |==============================================================================|
  56. |For Help, reboot then type: MCAT //                                           |
  57. |  Scratch Disk Must Remain In Drive A:                                        |
  58. |                                                                              |
  59. |The DISK TO BE CATALOGED and the CATALOG SYSTEM DISK                          |
  60. |will alternately be placed in Drive C:                                        |
  61. |                                                                              |
  62. |Catalog Drive C:  (NO = Exit)   Ready? (Y/N) : _                              |
  63. |                                                                              |
  64. |                                                                              |
  65. +------------------------------------------------------------------------------+
  66.  
  67.  
  68.    If no recognizable clock driver is found  (Plu*Perfect Systems' DateStamper 
  69. (tm), ZSDOS or CP/M Plus),  you will  be prompted to enter  the current month, 
  70. day and year.  When a catalog including Date information is updated with MCAT, 
  71. the current date is then added to the pseudo file  '+++nnnk.FRE'  which  shows 
  72. the number of free kilobytes on the  disk.   By examining  this  entry in  the 
  73. Master Catalog,  the date  of  cataloging  is then  known.    With  XCAT, this 
  74. current  date is presented  in printed  and file output listings.   As  a side 
  75. effect, if  a disk is cataloged on different days with no intervening changes,
  76. that one file is deleted, and one added in the second operation.
  77.  Commands - 1/3 
  78.  
  79. Five commands are available at any point from the main prompt (the last one on
  80. the screen shown above).  These commands are:
  81.  
  82.  ^D  (Control-D) - Define  the  disk  drive  to  catalog.   A  command  prompt 
  83.      (beginning with '==>') is issued, and a single character is accepted with 
  84.      no  carriage  return.   If  a space,  carriage  return,  or other control 
  85.      character is entered, no change is made to the current drive.
  86.  
  87.  ^L  (Control-L) - Log  the  drive  and user  area  which  contains (or should 
  88.      contain) the MAST.CAT Master Catalog file.   The expected  response i s a 
  89.      letter followed by one or more numbers.  If only a letter is entered, the 
  90.      user ares is unchanged.   If only a number is entered, then the currently 
  91.      selected drive is retained, and the user area is changed.  The  entry  is 
  92.      terminated when a non-numeric character is  detected.   NO EDITING of the 
  93.      entry is supported  (e.g. backspace).   If the first character entered is 
  94.      a space or carriage return, the current selection is unchanged.
  95.  Commands - 2/3 
  96.  
  97.  ^I  (Control-I) - Initialize  a  MAST.CAT file on the currently selected disk 
  98.      and user area.   To  avoid inadvertant  erasure  of  an  existing  Master 
  99.      catalog, two levels of  protection  are provided;  First,  a confirmation 
  100.      prompt is given,  and secondly,  MCAT renames  any  existing  MAST.CAT to 
  101.      MAST.BAK.
  102.  
  103.  ^F  (Control-F) - Change the Format to be used for the MAST.CAT.  Two Command 
  104.      prompts (beginning  with ==>)  are  given  which  expect  Yes or No (Y/N) 
  105.      responses.   These define whether or not to include USER and DATE entries 
  106.      in the Master Catalog.
  107.  
  108.  ^R  (Control-R) - Remove  references  to  a  specified  disk.   The  user  is 
  109.      prompted to enter a disk name.  This should match the name of a disk (the 
  110.      leading dash is shown in the prompt) to be deleted.   To insure that this 
  111.      is OK, a confirmation prompt is issued  which expects  a 'Y/N'  response.  
  112.      All MAST.CAT entries containing this  name as  a disk ID will be  removed 
  113.      from the catalog.  Editing (backspace) is supported during name entry.
  114.  Commands - 3/3 
  115.  
  116.  ^Z  (Control-Z) -  The terminal screen is  cleared  and  redrawn.  This is to 
  117.      support programs that  may  be  activated  from  within  your  system and 
  118.      destroy the screen.
  119.  
  120.  
  121.    At any point in the program where  Yes  or  No  responses are expected, the
  122. following conventions apply:
  123.  
  124.    NO  = 'N', 'n', Control-C, or Control-X.
  125.    YES = 'Y', 'y', Carriage Return  (Control-M),  Space,  all other characters
  126.                not covered by NO.
  127.  
  128.  
  129.    To exit MCAT,  simply respond with  a NO answer to  the main command prompt
  130. that asks if the disk to  be cataloged is installed in the  correct drive.   A 
  131. warm boot will then be performed back to CP/M.
  132.  Interactive Mode 
  133.  
  134.    Interactive mode is  initiated  by  adding  arguments  to the command line.
  135. Each option is  preceeded with  a special character.   Any or all of the three
  136. parameters may be added in any order.  These parameters are:
  137.  
  138.   < - indicates that the following character  designates the  disk drive to be
  139.       be cataloged.  Can be followed by an optional colon for clarity.
  140.  
  141.   > - indicates that the following parameters  designate  the driver/user area
  142.       where the desired MAST.CAT file is to be found.   A letter indicating  a 
  143.       drive, a number in the range of 0-31, or both may follow this symbol.
  144.  
  145.   $ - specifies the format of the MAST.CAT entries.   When detected, both USER
  146.       and DATE capabilities  are  turned  off,  and  must be explicitly reset.  
  147.       Follow this symbol with a "D" for Dates to be included, and "U" for user
  148.       areas to be included.  Either one or both characters are accepted.
  149.  
  150.    If any of  these  parameters  are missing  from  the  command line, default 
  151. parameters are assumed.  These defaults can be changed using ZCNFG. 
  152. :3
  153.  Configuration 
  154.  
  155.    MCAT is  configured  using  ZCNFG  vs 1.3  or later.   Options  and default 
  156. settings are  contained in  MCAT6.CFG.   Configuration  should  be  relatively 
  157. self-explanatory for each program, and Help is available for each program from 
  158. within ZCNFG.  
  159.  
  160.    For those who  desire  a  graphics  string  to  generate  a horizontal line 
  161. instead of a single character,  a method of defining a character string  of up 
  162. to 16 characters by using  the file CAT6GPH.Z80.   This  file  defines  a flag 
  163. value and the user-supplied string at the needed address in the header section 
  164. of both MCAT6 and XCAT6.   It should  be assembled to a HEX file and overlayed 
  165. on the programs with MLOAD or a debugger such as DDT.
  166. :4
  167.  MCAT Notes - 1/3 
  168.  
  169.    a. Version 6 updates: 
  170.       - cataloging of date-stamped disks by DateStamper(tm), CP/M Plus, or any
  171.         flavor of ZSDOS.
  172.       - addition of Library (file type LBR) members to the catalog.
  173.       - ability to retrieve files based on Date specifications with XCAT.
  174.       - operation under CP/M 2.x, ZRDOS 1.x, ZSDOS and CP/M Plus.
  175.       - automatic screen installation under ZCPR 3.x.
  176.       - named directory support under ZCPR 3.x.
  177.       - retention of original Catalog Creation Date if stamping used.
  178.       - backward  compatability   with  Version  5  catalogs   with  automatic
  179.         conversions as necessary.
  180.       - enhanced user feedback, particularly under ZCPR 3.
  181.  MCAT Notes - 2/3 
  182.  
  183.    b. To indicate that a file in the data base is contained in  a library, the 
  184.       Most Significant Bit is set in the last character of the File Type,  and 
  185.       the Disk Name field of  the record  entry (normally blank)  contains the 
  186.       name of the  parent LBR file.   If user data is included in the catalog, 
  187.       it will be set to that of the parent library file.   If date information 
  188.       is included,  it will  be extracted from the library, or  set  to a null 
  189.       field if no dates are present.  
  190.  
  191.    c. Previous MCAT versions used a fixed size for the subject disk directory, 
  192.       and permitted up to 2048 directory entries on  larger systems.   Since a 
  193.       priori knowledge of the exact size cannot be known with library files, a 
  194.       dynamic scheme was developed which should permit slightly more than 2100 
  195.       names to exist for a single disk with a system size in excess of 53k.  A 
  196.       warning is issued if all files cannot be added,  and users are given the 
  197.       option of cataloging just the primary files, or aborting the operation.
  198.  MCAT Notes - 3/3 
  199.  
  200.    d. Some deficiencies in previous versions have been corrected in Version 6.
  201.       The  most significant include the  possibility for Catalog corruption by 
  202.       commas in  file  names,  and  the  failure  to properly  add valid files 
  203.       beginning with a dash  to the data base.   Neither  of  these weaknesses 
  204.       exist in Version 6.
  205. :5
  206.  
  207.  Examples of Use 
  208.  
  209.    a. MCAT6 <A >B10 $U   <-- Catalog the 'A' drive, Look for MAST.CAT on drive
  210.       MCAT6 <A: $U >B10:     'B' User area 10,  Catalog  only  file  names and 
  211.                              User areas.
  212.  
  213.    b. MCAT6 <C $DU       <-- Catalog the 'C' drive,  Look for MAST.CAT  on the
  214.       MCAT6 <C $UD           default drive  in  default  area,  Catalog  names 
  215.       MCAT6 $DU <C:          w/Date and User areas
  216.  
  217.    c. MCAT6 $            <-- Catalog default drive,  Look for MAST.CAT  on the
  218.                              default drive in default area, Catalog only Names