home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / zsus / z3help / s.lbr / SAPZ.HZP / SAPZ.HLP
Encoding:
Text File  |  1991-11-18  |  6.1 KB  |  129 lines
  1. ;
  2.                                    SAPZ.COM                                   
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5.                2k (16)   C3BF  1.2        Howard Goldstein 10/91   Z3COM12
  6.  
  7.   1- Syntax  2- Erasing Files  3- Datestamps  4- Relog  5- Config  6- Notes   
  8.  
  9.    SAP-Z is a ZCPR3 utility that sorts and packs a disk  directory.   It reads
  10. the disk directory tracks,  sorts them alphabetically,  erases the tracks with
  11. E5's, and then rewrites them.   Sorting the  directory in this  manner  offers
  12. several advantages:  (1) it allows  DIR to show an  alphabetized listing;  (2)
  13. it minimizes problems when using UNERASE; (3) it speeds up access by directory
  14. programs;  (4) it assists on working directly on the disk with disk  utilities
  15. such as DU;  (5) it prevents somebody else from reading files you erased;  and
  16. (6) it optionally erases all null  (zero-length)  files,  except  disk  labels
  17. starting with a special tag character.
  18.  
  19.    Original (10/6/90) by Gene Pizzetta.  Based on SAP60 (7/27/87) by Irv Hoff,
  20. original by L. E. Hughes (1977).
  21. :1
  22.  Syntax   SAPZ dir:
  23.  
  24.    Either a DU or a DIR specification must be used; for safety, the default DU
  25. is not assumed.   Only the drive is significant, but if only a user specifica-
  26. tion is given, the default drive is selected.   If run in a non-ZCPR3 environ-
  27. ment, only a drive letter followed by a colon should be specified.
  28.  
  29.    If no drive specification is given, a brief usage message is displayed.
  30.  WHAT IT DOES 
  31.  
  32.    SAP-Z is a program developed through the  years to clean up the disk direc-
  33. tory tracks of a  CP/M disk.   It works equally well on tiny  floppy drives or 
  34. gigantic hard drives with a capacity in  excess of 100 megabytes.   The direc-
  35. tory is checked to see how many files it contains and memory is checked to see
  36. if it is  sufficient.   (At 32 bytes per filename more than 1500 filenames can 
  37. be easily handled with a 50k TPA, and most users have more TPA than that.)
  38.  
  39.    The filenames are read into  memory from the  directory  tracks,  then  the
  40. entire directory track area is  cleaned off  using E5h characters.   The file-
  41. names are sorted using the same fast sort routine in current versions of Super
  42. Directory (SD), and then  writes  them  back  to  the  directory in alphabetic
  43. order.
  44.  
  45.    SAP-Z can do strange things if there are garbaged  entries on the directory
  46. tracks, so it's best to use a program like CHKDIR first and make any necessary
  47. corrections before running SAP-Z.
  48. :2
  49.  ERASING FILES 
  50.  
  51.    SAP-Z erases files  with  a filetype  of "$$$" and, optionally, erases null
  52. ("zero-length") files (see "Configuration", below).
  53.  
  54.    Many people use  names on their user  areas to  identify  that directory or
  55. disk labels for cataloging with FATCAT, MCAT, or NCAT.  These are usually null
  56. (zero-length) files:
  57.  
  58.      -UPLOADS       0k   ; for RCP/M directory identification
  59.      #GAMES  .123   0k   ; for catalog programs
  60.  
  61. You obviously don't want these files erased by SAP-Z,  so ZCNFG can be used to
  62. configure SAP-Z to keep all null  files,  erase all null  files,  or erase all
  63. null files except those beginning with  your label tag character (see "Config-
  64. uration", below).
  65. :3
  66.  DATE STAMPED FILES 
  67.  
  68.    SAP-Z preserves DateStamper file date stamps.  These routines were added by
  69. Bridger Mitchell of Plu*Perfect  Systems.   After the  directory is sorted and
  70. written back to the  directory  tracks,  the !!!TIME&.DAT  file is  sorted and
  71. rewritten also, so all date stamps are kept in the right order.
  72. :4
  73.  RELOGGING 
  74.  
  75.    SAP-Z no longer requires  calling  RELOG  or  DISKRST  to reset hard disks.
  76. This is done using function 37 in a manner that is safe even under DRI's BDOS.
  77. :5
  78.  CONFIGURATION - 1/2 
  79.  
  80.    SAP-Z can be used without alteration on any size  floppy or hard drive.  It
  81. is intended only for a CP/M 2.2 compatible BIOS.   The program will abort with
  82. a message if it run under Z3PLUS.
  83.  
  84.    Two configuration options are  available and may be set using ZCNFG and the 
  85. SAPZnn.CFG file.   Do not change the  name of the CFG file.   The name ensures
  86. that ZCNFG will be  able to find the correct  configuration  file  even if the
  87. name of SAP-Z is changed.
  88.  
  89.    The first  configuration  option  determines  whether null  files  will  be
  90. erased.  By default null files are left alone.   A "YES" (non-zero value) here
  91. allows them to be erased.
  92.  CONFIGURATION - 2/2 
  93.  
  94.    The second  configuration  option  has no  effect  unless the  first option
  95. (above) is set to "YES".  The option sets the tag character.   The tag charac-
  96. ter is the first  character of disk  labels,  such as those used by cataloging
  97. programs.   This character is usually "-" (2Dh), "#" (23h),  or "!" (21h).  If
  98. this option is configured to a non-zero value, disk labels beginning with that
  99. value will not be erased, even if Option 1 is "YES".  If you don''t want disk'
  100. labels preserved, make this option null (00h).
  101. :6
  102.  SAPZ Notes - 1/2 
  103.  
  104.    a. Vs 1.2 updates (9/27/91, Howard Goldstein):
  105.       - Converted to Zilog mnemonics.  
  106.       - Enlarged stack to  eliminate  strange  behavior  reported  by  various
  107.         users.  
  108.       - Eliminated ZCPR3 requirement.  
  109.       - Fixed treatment of S2 byte for compatibility  with  ZSDOS' larger file
  110.         capacity.  
  111.       - Shortened and cleaned up code.  
  112.       - Simplified RELOG routine and  moved  initial disk reset to before disk
  113.         select.
  114.  
  115.    b. Vs 1.1 updates (10/13/90, Gene Pizzetta):
  116.       - Added relogging.   Under CP/M  and ZRDOS all drives are relogged using
  117.         both functions 37 and 13.   Under  ZSDOS and  ZDDOS only the  specific
  118.         drive is relogged using function 37.
  119.  SAPZ Notes - 2/2 
  120.  
  121.    c. Vs 1.0 updates (10/06/90, Gene Pizzetta):
  122.       - Based on SAP v60.  For ZCPR3 only.  
  123.       - Now requires drive spec, or gives usage message.  
  124.       - Accepts DU or DIR form, but only drive is significant.  
  125.       - Now uses Z80 opcodes, including relative jumps.  
  126.       - Changed from absolute to relocatable code, and added version 4 library
  127.         routines.  
  128.       - Made configurable with ZCNFG.
  129.