ftp.barnyard.co.uk/2015.02.ftp.barnyard.co.uk.tar/ftp.barnyard.co.uk/cpm/walnut-creek-CDROM/ZSYS/ZSYSARK/Z3HLP01.ARK/E.LBR/ERAZ.HZP/ERAZ.HLP

Text File | 1990-03-23 | 10KB | 232 lines

;
                        
                     
                        
  ---  E R A Z  ---  
                        
                     
                             Version 1.4

          An Enhanced ZCPR3-Compatible File Erasing Utility


                    I --> 
 Installation    
                    O --> 
 Overview        
                    S --> 
 Syntax          
                    / --> 
 Options         
                    E --> 
 Error Flag      
                    M --> 
 Modifications   
:I


 Installation 

The distribution version of ERAZ is supplied with an AMPRO standard Z3ENV
address of FE00H.  ZCPR 3.0 users with other Z3ENV locations should install
ERAZ using their regular installation methods.

No installation is required for operation in ZCPR 3.3+ or non-ZCPR3
environments.  When ERAZ operates in a non-ZCPR3 environment, several
locations affecting program operation may be patched as described in the
file ERAZ.PAT, although the default values should be satisfactory for most
users.

:O


 Overview - 1/2 

ERAZ is an enhanced Z80 file erasing utility for use with CP/M 2.2 or ZCPR3
CCP's running under CP/M 2.2, Z80DOS, ZRDOS, ZSDOS and other extended
DOS's.  ERAZ has not been tested with CP/M 3.0.

ERAZ was developed as a fast, general purpose file erasing utility with
flexible command line option control over many aspects of the erasing
process, as well as a companion to the ACOPY series of file utilities.  It
can help reduce the ALIAS command line length required to erase groups of
files with unrelated names by optionally erasing only those files that have
any of the specified filename attributes (the high bits of the filename and
filetype bytes) F1 through F7 set (erase if ANY of the selected attributes
are set).  Filename attributes may be set using the ZRDOS utility SFA (Set
File Attributes) or a similar CP/M Public Domain utility such as DA.  See
the 'Options' section for information on the rest of the ERAZ's command
line options.


 Overview - 2/2 

ERAZ is fully ZCPR3 compatible when operating in a ZCPR3 environment,
accepting both the DIR: and DU: forms and checking the environment for the
validity of the drive and user specified, whether it is to be operating in
a quiet environment and the name the program was called by for use in the
command line HELP message.  ERAZ will operate using the ZCPR3 GO command.
Errors will cause the ZCPR3 program error flag to be set.  When operating
in a ZRDOS environment, files in the PUBLIC areas are protected.

When ERAZ operates in a non-ZCPR3 environment, the required information is
obtained from internal locations, which may be patched to suit your system
as described in the file ERAZ.PAT.  ERAZ will not accept the DIR: form when
operating in a non-ZCPR3 environment.

:S


 Syntax - 1/3 

To help you clear your workspace with a single command, ERAZ allows you to
specify up to 18 separate ambiguous filenames on the command line.  The
syntax is:

     ERAZ [dir:]afn1 [[dir:]afn2 ...] [>excluded] [/option(s)]

Normally the default dir: specification is the currently logged dir:, and
is carried over to filenames with no specified dir:.  The 'C' option makes
the last specified dir: the default so that it will carry over to
subsequent filenames.  Any options also specified, including any excluded
filename mask, will be applied to all filenames.


 Syntax - 2/3 

Whenever you include the wildcard filename mask '*.*' (unless you also
specify the Inspect (/I) option or the Override (/O) option), ERAZ will ask
you if you want to "Erase ALL Files?" and will await a response from you
before all specified files are erased.  This is to help prevent
accidentally erasing all your files due to the slip of a finger.  Any
response except 'Y' or 'y' will cause ERAZ to abort at that point.  If you
specify the Override option, which is primarily intended for use in alias
command lines, ERAZ will erase all files, as specified, WITHOUT first
warning you.

If you do accidentally erase any files, IMMEDIATELY use an file unerase
utility such as UNERAZ, UNERA, or UNERASE before performing any operations
that will write any files to your disk!  Disk write operations may reuse
any directory entries marked as erased, and thereby make it impossible to
recover your erased files or may result in recovering files with missing
extents.


 Syntax - 3/3 

You may sometimes want to erase a group of files specified by a
filename/attribute mask which also includes some files you don't want
erased.  You can optionally add a filename mask to specify files that you
wish to exclude from erasing, even if they otherwise match the source file
specification.  The exclusion filename mask can be located anywhere in the
command line, but since ERAZ allows multiple filename specifications, the
exclusion filename mask must be prefixed with the exclusion filename flag
character '>'.  The exclusion filename is a filename mask only, and any
drive/user specified will be ignored.  For example:

          A0:WORK>eraz util:files*.* fubar.* >*.com

will erase all files UTIL:FILES???.??? and A0:FUBAR.???, but won't erase
any files named ????????.COM.

:/


 Options - 1/7 

ERAZ has a number of command line options, which must be preceded by the
option flag character '/'.  The option letters or numbers may appear in any
order and may appear anywhere in the command line.  Options may be combined
in any combination.  Options are toggled as they are read, so that an
option appearing twice will cancel itself.  All of the following command
lines have the same meaning:

          A0>eraz afn1 afn2 >excluded.fn /12q
          A0>eraz afn1 /1 >excluded.fn afn2 /2q
          A0>eraz >excluded.fn /12 afn2 /q afn1
          A0>eraz /q /q afn1 >excluded.fn /q /21 afn2


The following descriptions of the options reflect the default option
settings in the distribution version.  You may change the default option
settings to suit your own needs by patching.  See ERAZ.PAT for more
information.  The command line HELP screen will automatically display the
proper selection message for each option based on whether it has been set
to ON or OFF.


 Options - 2/4 

The options are:

     1 - 7 options.  Erases only those specified files which also
          have the selected combination of the F1 through the F7
          attributes set.

     N - Erases only NON-archived (changed) files.  Under ZRDOS,
          ZSDOS and other extended DOS's, the 'N' option allows
          you to limit erasing to non-archived files (those files
          that have been opened or modified since the archive
          attribute was set).

          Under CP/M 2.2, the archive attribute is not reset when
          a file is updated, so this option is not too useful
          unless you use a utility program to 'manually' set or
          reset the archive attribute.

     A - Erases both directory and system files.  The default is
          to erase directory files only.


 Options - 3/4 

     O - Overrides the 'Erase ALL Files?' question when
          specifying all files (*.*).  Normally, you are warned
          and asked.

     R -  Erases R/O files without asking.  Normally, you are
          asked first.

     C - Carry over the last specified drive/user as the default
          to succeeding filename mask specifications.  Normally
          the currently logged du: is the default.

          The C option allows you to erase files on a du:
          different from the currently logged du: without having
          to specify the new du: each time you specify a
          different filename mask.  If this option is patched to
          be normally ON, selecting the C option will then make
          the currently logged du: the default.


 Options - 4/4 

     I - Inspect option.  Displays each proposed erase and asks
          for operator approval before proceeding.  The default
          is to automatically erase R/W files without asking.

     Q - Quiet option.  Turns off non-error messages.  Any
          information you should know about during the erasing
          process, such as error information, is still displayed.
          Will not erase any system or R/O files unless the A or
          R options are also used.

          When operating in a ZCPR3 environment, the Q option
          initial setting will automatically be set according to
          the state of the ZCPR3 QUIET flag.  If the Q option has
          an initial setting of ON, the use of Q in the command
          line will then toggle the Q option OFF.  The HELP
          screen will automatically display the proper meaning of
          the Q option.
:E


 ZCPR3 Program Error Flag 

ERAZ sets the ZCPR3 program error flag, if it exists, when an error occurs
during program operation.  For more flexible use in alias and ZEX scripts,
ERAZ14 follows the convention set by Rick Charnes by setting the error flag
to the following values for the indicated error conditions:

     8 = User abort
  0FFH = Fatal error (which will terminate ERAZ operation)

:M


 Modifications 

ERAZ has several locations near the beginning of the program that can be
patched using DDT, PATCH, ZPATCH, etc, to alter the operation of the
program to suit the user.  See the file ERAZ.PAT for further information.

You now can use Al Hawley's file configuration utility ZCNFG.COM (supplied
with ZSDOS and also available from the Ladera Z-Node at [phone]) as
an alternate to manual patching of ERAZ14.COM with DDT, ZPATCH, etc.
ZCNFG.COM, used with the configuration file ERAZ14.CFG, allows you to
display and set the most commonly used program and option defaults,
including most option characters and option default settings.  Some option
characters and defaults, such as the attribute options 1-7, can not be set
by ZCNFG, as it is recommended that those defaults be left set at OFF.
ERAZ14.CFG can only be used with ERAZ14 and will not work correctly with
earlier versions.