home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / zsus / z3help / u.lbr / UMAP.HZP / UMAP.HLP
Encoding:
Text File  |  1991-11-18  |  7.6 KB  |  156 lines
  1. ;
  2.                                    UMAP.COM                                   
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5. UMAP.3OM       2k (16)   D4A5  1.80       Gene Pizzetta 10/91      Z3COM23
  6. UMAP.4OM       3k (22)   EC57  1.80       Gene Pizzetta 10/91      Z3COM23
  7. UMAP.COM       2k (16)   903C  1.80       Gene Pizzetta 10/91      Z3COM23
  8.  
  9.   1- Syntax/Options  2- Operation  3- Configuration  4- Notes                 
  10.  
  11.    UMAP is a  ZCPR3  utility that can  display a  brief map of a disk, showing
  12. which user areas have files and  how  many  directory entries those files use.
  13. Or, it can  display a list of vacant  user  areas,  users with no  files.   In
  14. addition,  it can  display a brief  summary of the total  number of  directory
  15. entries used,  the number of  entries  still  free  and the disk free space in
  16. kilobytes.
  17.  
  18.    Version 1.0 (2/18/91) by Gene Pizzetta.  The idea for UMAP came from USRMAP
  19. (author unknown) and at the urging of Howard Schwartz.
  20. :1
  21.  Syntax   UMAP {dir:} {{/}option}
  22.  
  23.    Although a DU or DIR specification may be given,  only the drive is signif-
  24. icant.  If no drive is given, the current drive is assumed.
  25.  Options - 1/2 
  26.  
  27.    Only one command-line option can be given.  It may be given with or without
  28. a slash and with or without a drive specification.  If more than one option is
  29. given, only the first will be observed.  Invalid options are ignored.
  30.  
  31.      U    Show complete directory statistics for each user area 
  32.           on the disk that has active files.  User areas with no 
  33.           files will be omitted from the display.  Although few 
  34.           people will have files in more than a screenful of user 
  35.           areas, if you have files in most of the 32 available 
  36.           users, the display will be automatically paused 
  37.           ("[more]") at the end of each screen.  The number of 
  38.           screen lines is obtained automatically from the 
  39.           environment.
  40.  Options - 2/2  
  41.  
  42.      V    Show a list of vacant user areas (those with no active 
  43.           files).  If all you're looking for is an empty 
  44.           directory, there's no need to watch a list of user area 
  45.           statistics scroll by, possibly taking up more than one 
  46.           screen, and then have to try to figure out which users 
  47.           are not listed.  With this option, only vacant user 
  48.           areas will be listed.  Only two screen lines will be 
  49.           used to display them, with users 0-15 on the first 
  50.           line, 16-32 on the second.  If you only use 16 user 
  51.           areas, you can ignore the second line.  For quick 
  52.           referece, users with active files are represented by a 
  53.           dot instead of a number.
  54.  
  55.    With no options only total directory usage and free disk space is shown.
  56. :2
  57.  Operation 
  58.  
  59.    User areas with no files will be  omitted  from the display.  Although  few
  60. people will have files in more than a  screenful  of user  areas,  if you have
  61. files in most of the 32 available  users,  the  display  will be automatically
  62. paused  ("[more]")  at the end of  each screen.  The number of screen lines is
  63. obtained automatically from the environment.
  64.  
  65.    UMAP sets the  ZCPR3  program  error  flag  on  error,  but  the only error
  66. currently recognized is an invalid (out of range) directory specification.
  67.  
  68.    Large files require more  than  a  single  directory  entry,  so  UMAP will
  69. display both the number of  files  and  number of directory  entries they use.
  70. Finally, it tells you how many free directory entries are left on the disk and
  71. the amount of remaining disk space in kilobytes.  The number of free directory
  72. entries will not be accurate if P2DOS datestamping is used.
  73.  Checking All Drives - 1/2 
  74.  
  75.    It has been suggested to me that UMAP have the  ability to  give  user area
  76. statistics for a group of drives,  one after the other,  with  screen  paging.
  77. While not a bad idea,  implementing  that  mode  would  add  significantly  to
  78. program size,  certainly making it  larger  than  two kilobytes.   The limited
  79. usefulness of such a mode, I think, makes it not worth it.
  80.  
  81.    However, a simple alias could accomplish the same thing:
  82.  
  83.      UMAP A:U;IF IN MORE?;FI;UMAP B:U;IF IN MORE?;FI;UMAP C:U...
  84.  
  85.    This causes a simple page pause after each drive's usage is displayed.  Or,
  86. if you want to be able to abort the alias after any call to UMAP,  put all the
  87. "FI"'s at the end:
  88.  
  89.      UMAP A:U;IF IN MORE?;UMAP B:U;IF IN MORE?;UMAP C:U...;FI;FI;...
  90.  
  91.    If you have too many drives for a single alias, the last command could be a
  92. call a second alias.   Of course, there are more elaborate ways of doing this,
  93. but I'm not doing a tutorial on writing aliases here.
  94.  Checking All Drives - 2/2 
  95.  
  96.    You might have noticed in the examples  above that the  option  came  right
  97. after the drive spec without an intervening space.  That works fine with UMAP.
  98. :3
  99.  Configuration 
  100.  
  101.    UMAP can be configured to make either of the  options  the  default mode of
  102. operation.   In that case either of the  command-line  options  will  turn the
  103. default mode off.   Do not configure  UMAP  to default to both options.   That
  104. won't work and you will lose access to the "no option" mode.
  105.  
  106.    In addition, the vacant user area display can be configured as compacted to
  107. the left or spaced across the screen.
  108.  
  109.    To configure UMAP use the accompanying  UMAPnn.CFG file and ZCNFG.   Do not
  110. change the name of the CFG file so that  ZCNFG  can  find it,  even if you use
  111. another name for UMAP.
  112. :4
  113.  UMAP Notes - 1/3 
  114.  
  115.    a. Version 1.8 updates (10/10/91, Gene Pizzetta):
  116.       - A stack problem occurred when running UMAP under BYE.   The stack size
  117.         has been increased to (hopefully) solve the problem.  
  118.       - Also, replaced Z3LIB's PRTNAME with GCOMNAM  from  ZSLIB,  so the disk
  119.         name displays properly with the GO command.
  120.       - A couple of minor display changes.
  121.  
  122.    b. Version 1.7 updates (4/20/91, Gene Pizzetta):
  123.       - With U option, now shows directory name, if any, for each user area. 
  124.  
  125.    c. Version 1.6 updates (4/14/91, Gene Pizzetta):
  126.       - Modified display of vacant users, which also resulted in simpler code.
  127.       - A few other display changes were made.  
  128.       - Added configuration byte for extra space between vacant users.
  129.  
  130.    d. Version 1.5 updates (4/10/91, Howard Goldstein):
  131.       - Cleaned up code.  No functional changes.
  132.  UMAP Notes - 2/3 
  133.  
  134.    e. Version 1.4 updates (3/27/91, Gene Pizzetta):
  135.       - With V option,  now prints only users 0-15 on first line,  users 16-31
  136.         on second line.
  137.  
  138.    f. Version 1.3 updates (3/26/91, Gene Pizzetta):
  139.       - Minor changes in display for aesthetical considerations:  free entries
  140.         and free space are printed on separate line.  
  141.       - At the suggestion of Rob Wood,  added V option for  vacant  user  area
  142.         display.  Added type 3 and type 4 assemblies.
  143.  
  144.    g. Version 1.2 updates (3/25/91, Gene Pizzetta):
  145.       - Now re-initializes the drive byte in the FCB  with a question  mark so
  146.         UMAP will work with the GO command under ZRDOS.   It seems that  ZRDOS
  147.         resets the byte to zero, for no known reason.   Thanks to Rob Wood for
  148.         discovering this idiosyncrasy.  
  149.       - Added ability to count entries beyond user 31.   ZSDOS does not return
  150.         them.  DRI's CP/M-Plus does.  It's there if it works on your system.
  151.  UMAP Notes - 3/3 
  152.  
  153.    h. Version 1.1 updates (2/23/91, Gene Pizzetta):
  154.       - Added disk space display.  
  155.       - Removed VLIB routines to save a lot of bytes.
  156.