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 / CPM / UTILS / DIRUTL / ERAZ11.LBR / ERAZ11.DZC / ERAZ11.DOC
Text File  |  2000-06-30  |  10KB  |  258 lines
  1. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  2. *                                *
  3. *                E R A Z                *
  4. *                                *
  5. *         A ZCPR3-Compatible File Erasing Utility        *
  6. *                                *
  7. *                                *
  8. *                   by                *
  9. *               Terry Hazen                *
  10. *              21460 Bear Creek Road            *
  11. *               Los Gatos, CA 95030            *
  12. *             (408) 354-7188             *
  13. *                                *
  14. *                                *
  15. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  16.  
  17.  
  18. Latest Revision
  19. ---------------
  20.  
  21. Version 1.1 - 05/06/88.  See ERAZ11.HIS for revision details.
  22.  
  23. =================================================================
  24.  
  25.  
  26. Overview
  27. --------
  28.  
  29. ERAZ is an enhanced Z80 file erasing utility for use with ZCPR3
  30. and CP/M 2.2 or ZRDOS.    ERAZ has not been tested with CP/M 3.0.
  31.  
  32. ERAZ was designed as a general purpose file erasing utility as
  33. well as a companion to the ACOPY series of file utilities.  It
  34. can help reduce the ALIAS command line length required to erase
  35. groups of files with unrelated names by optionally erasing only
  36. those files that have been tagged with any combination of the
  37. file attributes F1 through F7 (erase if ANY of the selected
  38. attributes are set).
  39.  
  40. For example, ERAZ can be used with the /2 option to clear a RAM
  41. disk of the files that were loaded for a specific application
  42. using ACOPY and the same /2 option (copying only files having the
  43. attribute F2 set), leaving the RAM disk with all other files
  44. intact and ready for another application to be loaded.
  45.  
  46. Files may be tagged using the ZRDOS utility SFA (Set File
  47. Attributes) or a similar CP/M Public Domain utility such as DA.
  48. ERAZ also has a number of other options which are described
  49. below.
  50.  
  51. ERAZ is fully ZCPR3 compatible when operating in a ZCPR3
  52. environment, accepting both the DIR: and the DU: forms and
  53. checking the environment to obtain the maximum drive and user
  54. that will be accepted, whether it is to be operating in a quiet
  55. environment, and the name under which the program was called forèuse in the HELP message.  Errors will cause the ZCPR3 program
  56. error flag to be set.  When operating in a ZRDOS environment,
  57. files in the PUBLIC areas are protected.
  58.  
  59. When ERAZ operates in a non-ZCPR3 environment, the required
  60. information is obtained from internal locations, which may be
  61. patched as described below.  ERAZ will not accept the DIR: form
  62. when operating in a non-ZCPR3 environment.
  63.  
  64.  
  65. Installation
  66. ------------
  67.  
  68. The distribution version of ERAZ is supplied with an AMPRO
  69. standard Z3ENV address of FE00H.  ZCPR3.0 users with other Z3ENV
  70. locations should install ERAZ using Z3INS.COM and SYS.ENV in the
  71. normal manner.
  72.  
  73. No installation is required for operation in ZCPR3.3 or non-ZCPR3
  74. environments.  For operation in a non-ZCPR3 environment, the
  75. maximum drive and user that will be accepted may be patched as
  76. described below.
  77.  
  78.  
  79. Syntax
  80. ------
  81.  
  82.       ERAZ [dir:]afn1 [[dir:]afn2 ...] [/option(s)]
  83.  
  84. To help you clear your workspace with a single command, ERAZ
  85. allows you to specify up to 16 separate ambiguous filenames on
  86. the command line.  Note that each filename specified requires its
  87. own DIR: or DU: reference.  However, any options also specified
  88. will be applied to ALL filenames!
  89.  
  90. Whenever you include the wildcard filename mask '*.*' (unless you
  91. also specify the Inspect (/I) option), ERAZ will ask you if you
  92. want to "Erase ALL Files?" and will await a response from you
  93. before all remaining files are erased.    This is to help prevent
  94. accidentally erasing all your files due to the slip of a finger.
  95. Any response except 'Y' or 'y' will cause ERAZ to abort at that
  96. point.
  97.  
  98. If you do accidentally erase any files, IMMEDIATELY use an file
  99. unerase utility such as UNERAZ, UNERA, or UNERASE before
  100. performing any operations that will write any files to your disk!
  101. Disk write operations may reuse any directory entries marked as
  102. erased, and thereby make it impossible to recover your erased
  103. files.
  104.  
  105.  
  106. Options
  107. -------
  108.  
  109. ERAZ has a number of command line options, which must beèpreceded by the option flag character '/'.  The option letters or
  110. numbers may appear in any order and may appear anywhere in the
  111. command line.  Options may be combined in any combination.
  112. Options are toggled as they are read, so that an option appearing
  113. twice will cancel itself.  All of the following command lines
  114. have the same meaning:
  115.  
  116.       A0>eraz /12q afn1 afn2
  117.       A0>eraz afn1 /1 /q /2 afn2
  118.       A0>eraz /12 afn2 /q afn1
  119.       A0>eraz /q /q afn1 /q /21 afn2
  120.  
  121.  
  122. The options are:
  123.  
  124.      I - Inspect option.  Displays each proposed erase and asks
  125.       for operator approval before proceeding.  The default
  126.       is to automatically erase R/W files without asking.
  127.  
  128.      A - Erases all (both directory and system) specified files.
  129.       The default is to erase directory files only.
  130.  
  131.      R - R/O option.  Erases R/O files without asking.    Normally,
  132.       you are asked first.
  133.  
  134.      1 - 7 options.  Erases only those specified files which also
  135.       have the selected combination of the F1 through the F7
  136.       attributes set.
  137.  
  138.      Q - Quiet option.    Turns off non-error messages.  Any
  139.       information you should know about during the erasing
  140.       process, such as error information, is still displayed.
  141.       Will not erase any system or R/O files unless the A or
  142.       R options are also used.
  143.  
  144.       When operating in a ZCPR3 environment, the Q option
  145.       initial setting will automatically be set according to
  146.       the state of the ZCPR3 QUIET flag.  If the Q option has
  147.       an initial setting of ON, the use of Q in the command
  148.       line will then toggle the Q option OFF.  The HELP
  149.       screen will automatically display the proper meaning of
  150.       the Q option.
  151.  
  152.  
  153. Optional ERAZ Modifications
  154. -----------------------------
  155.  
  156. ERAZ has several locations near the beginning of the program
  157. that can be patched using DDT, PATCH, ZPATCH, etc, to alter the
  158. operation of the program to suit the user.  The following table
  159. lists their locations and the distribution defaults.
  160.  
  161. If you are operating in a ZCPR3 environment and wish to rename
  162. the program, the name by which the program is invoked will
  163. automatically appear in the HELP message, and no patching need beèdone.
  164.  
  165. If you are primarily operating in a non-ZCPR3 environment, the
  166. program name, 'ERAZ', at location 010BH-0112H, may be patched to
  167. any desired new name, which will then appear at the proper places
  168. in the HELP message when it is called.    A maximum of eight
  169. characters are available.  Fill the unused character positions
  170. with space characters, as spaces in any of the eight locations
  171. will be ignored.  For example, to change the name of the program
  172. from ERAZ to ERA, you may simply patch the 'Z' in 'ERAZ' to a
  173. space character (20H) and the HELP message will then display
  174. 'ERA' with no extra spaces.
  175.  
  176. The option flag and the default option characters may be changed
  177. if you prefer other mnemonics.    The changed characters will
  178. automatically appear in the HELP message.
  179.  
  180. The options are all OFF-ON toggles. The default settings for the
  181. options may be changed from OFF (00H) to ON (0FFH) to allow, for
  182. example, always inspecting files before erasing without having to
  183. use the /I option.  Note that if you then use the /I option, it
  184. will turn OFF the automatic inspection.  If you change the option
  185. default settings by patching, the HELP message will automatically
  186. try to reflect these changes.
  187.  
  188. Since changing some of the default option settings may change the
  189. operation of ERAZ by removing some of the built-in safety
  190. factors that help prevent overwriting important existing files by
  191. accident, caution should be exercised in changing any of the
  192. default option settings!
  193.  
  194. If it is desired to eliminate ALL option choices following a
  195. given option, patch the FIRST undesired option letter or number
  196. to a 00H (for example, to eliminate the F1-F7 options, change the
  197. F1 byte at 0121H from '1' to 00H).  All subsequent option choices
  198. will no longer operate.
  199.  
  200. When ERAZ steps through a number of files, it may generate more
  201. than a screenful of display.  To help summarize what has
  202. happened, ERAZ displays the total number of files erased on
  203. completion of the program.  If you prefer not to have this
  204. display, patch location 0119H from FFH (display total number of
  205. files copied) to 00H (no display).
  206.  
  207.  
  208. Location    Default     Purpose
  209. ================================================================
  210.   010BH     'ERAZ    '     Program name (8 characters maximum)
  211.  -0112H                - Appears in HELP message
  212.  
  213.   0114H     '/'      Option flag character
  214.  
  215.   0115H     10H      Maximum drive allowed (A=1H, P=10H)
  216.  
  217.   0116H     0FH      Maximum user area allowed (15D=0FH)è
  218.   0119H     ON (FFH)     Display the number of files copied
  219.  
  220.   011AH     10H (16D)     Maximum number of filenames accepted
  221.              (This value may be decreased only)
  222.  
  223.   011BH     'I'      Inspect option character
  224.   011CH     OFF (00H)     Inspect default setting
  225.  
  226.   011DH     'A'      Include all files character
  227.   011EH     OFF (00H)     Include all files default setting
  228.  
  229.   011FH     'R'      Erase R/O & R/W files option character
  230.   0120H     OFF (00H)     Erase R/O & R/W files default setting
  231.  
  232.   0121H     '1'      F1 attribute option character
  233.   0122H     OFF (00H)     F1 attribute default setting
  234.  
  235.   0123H     '2'      F2 attribute option character
  236.   0124H     OFF (00H)     F2 attribute default setting
  237.  
  238.   0125H     '3'      F3 attribute option character
  239.   O126H     OFF (00H)     F3 attribute default setting
  240.  
  241.   0127H     '4'      F4 attribute option character
  242.   0128H     OFF (00H)     F4 attribute default setting
  243.  
  244.   0129H     '5'      F5 attribute option character
  245.   012AH     OFF (00H)     F5 attribute default setting
  246.  
  247.   012BH     '6'      F6 attribute option character
  248.   012CH     OFF (00H)     F6 attribute default setting
  249.  
  250.   012DH     '7'      F7 attribute option character
  251.   012EH     OFF (00H)     F7 attribute default setting
  252.  
  253.   012FH     'Q'      Quiet option character
  254.   0130H     OFF (00H)     Quiet option default setting
  255.  
  256. ================================================================
  257.  
  258.