home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / zsus / z3help / l.lbr / LD.HZP / LD.HLP
Encoding:
Text File  |  1991-11-18  |  11.9 KB  |  237 lines

  1. ;
  2.                                      LD.COM                                   
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5.                4k (32)   D55E  1.1        Gene Pizzetta 10/91      Z3COM11
  6.  
  7.   1- Syntax/Options  2- Displays  3- Security  4- Errs  5- Config  6- Notes   
  8.  
  9.  
  10.    LD is a ZCPR3 library directory utility that shows member files  along with
  11. their  create  and  modify  dates  and  times,  sizes,   compression   method,
  12. uncompressed filenames, CRC's, and indexes.   Embedded comments up to 76 char-
  13. acters can be displayed.   Output can  be  directed to the  printer.   Message
  14. register output and wheel protection  are  included.   It will also run  under
  15. vanilla CP/M 2.2 and CP/M Plus,  but only the current user is  accessible and,
  16. of course,  the  ZCPR3 features  will  not  work.   Vs 1.0  (10/07/91) by Gene
  17. Pizzetta.
  18. :1
  19.     Syntax   LD {dir:}lbrname {afn} {{/}options}
  20.  
  21.    If no DIR or DU specification is  given,  the  current  drive  and user are
  22. assumed.   If an ambiguous file  specification is given  following the library
  23. name, only member files matching it will  be  shown.   Otherwise,  all  member
  24. files will be shown.   A member filename beginning with a slash can be matched
  25. by preceding the filename with a colon.
  26.  Options - 1/4 
  27.  
  28.    A leading slash is required only if the member filespec is missing,  but it
  29. is allowed in any case.
  30.  
  31.      C    Show embedded comments.  Some crunched files have a 
  32.           text comment embedded in their headers.  This option 
  33.           will display them in highlighted video on the line 
  34.           following the member listing.  This option is ignored 
  35.           if the X option (alternate display) is used.
  36.  
  37.      D    Prefer embedded date stamps.  Ordinarily, LD checks the 
  38.           library directory for a date stamp and, if one is not 
  39.           found there, it looks for an embedded stamp in the 
  40.           headers of crunched files.  The first stamp found is 
  41.           displayed.  With this option, LD will first check for 
  42.           an embedded date stamp and use the library directory 
  43.           stamp only if an embedded stamp is not found or if the 
  44.           member file is not crunched.
  45.  Options - 2/4 
  46.  
  47.      X    Alternate display.  Two member files are shown per line 
  48.           with their CRC's and indexes.  Compression method, date 
  49.           stamps, and uncompressed member names are suppressed.  
  50.           Embedded comments cannot be displayed.  Since no member 
  51.           file headers are read, LD works faster than with the 
  52.           default display.
  53.  
  54.      S    Summary only.  Only the final summary line is displayed 
  55.           giving statistics for the library as a whole.  Since 
  56.           individual member files are not accessed, the summary 
  57.           is displayed very quickly.
  58.  
  59.      P    Don't page screen.  Normally, LD waits for a key to be 
  60.           pressed each time the screen fills.  With this option 
  61.           scrolling is continuous.  The screen can still be 
  62.           paused with ^S.
  63.  Options - 3/4 
  64.  
  65.      Q    Quiet mode.  Only error messages are displayed on the 
  66.           console.  This option is very useful when LD is being 
  67.           used only to load the message registers (option M).  It 
  68.           also allows sending the display to the printer without 
  69.           echoing it to the screen.
  70.  
  71.      M    Store results to memory.  The number of matching member 
  72.           files and the number of free (unused) library directory 
  73.           entries are stored in two two-byte words (low byte 
  74.           first) in four consecutive message registers.  As 
  75.           distributed, registers 18 through 21 are used.  LD's 
  76.           operation can be greatly speeded up if the S option is 
  77.           used with M.
  78.  
  79.      L    Echo to printer (LST:).  Printer output is not allowed 
  80.           if the wheel byte is off.  Screen paging is turned off 
  81.           automatically.
  82.  Options - 4/4 
  83.  
  84.      F    Send a final form feed to the printer.  Only effective 
  85.           if the L option is active, a form feed will be sent to 
  86.           the printer after the library directory is printed.
  87.  
  88.  
  89.    All options can be configured as  defaults  (see  CONFIGURATION).   In that
  90. case, the command line option will toggle to the non-default mode.
  91. :2
  92.  Displays - 1/3 
  93.    
  94.    The top line gives the drive,  user,  and name of the  library  file,  with
  95. attribute characters in  lower-case  and  highlighted.   The date and time the 
  96. library was created and last modified will also be  shown,  if they are avail-
  97. able in the library directory.
  98.  
  99.    There are two types of display screens.   Both  displays show the  names of
  100. matching member files and their sizes in records  (sectors) and in  kilobytes,
  101. including fractional parts of  a kilobyte  (.00, .12, .25, .37, .50, .62, .75,
  102. or .87, indicating 0 to 7 additional records).
  103.  Displays - 2/3 
  104.  
  105.    The DEFAULT DISPLAY,  which shows only one  member file per line,  includes
  106. the method by which the file was compressed as  "CR"  for GEL (LZW)  crunched,
  107. "LZH" for LZH crunched,  and "SQ" for squeezed.   Dashes means either the file
  108. is not compressed or it is compressed by an unrecognized method.
  109.  
  110.    The default display also shows, if possible,  the date and time each member
  111. file was created and last modified.   If no date  and  time  are  found in the
  112. library directory,  crunched files are  checked for embedded  datestamps.   If
  113. found,  they are displayed instead,  with a  "~"  between the date and time to
  114. indicate their source.
  115.  
  116.    Finally, the default display gives the real name of  crunched and  squeezed
  117. files--the name the file will have when it is uncompressed.
  118.  
  119.    If the C command line option is given with the  default  display and  if  a
  120. crunched file contains an embedded comment, the comment will be displayed on a
  121. separate line just below the entry for that  member,  up to 76 characters with
  122. video highlighting, usually surrounded with brackets.   If the  comment has to
  123. be truncated because it is too long,  there will be no closing  bracket.   (It
  124. should be noted, however,  that  occasionally  an  embedded comment may not be
  125. terminated in the file header with a closing bracket.)
  126.  Displays - 3/3 
  127.  
  128.    The ALTERNATE DISPLAY, which shows two member files per line, includes each
  129. file's cyclic redundancy checksum (CRC) and its index (position offset) within
  130. the library.   Embedded comments cannot be shown with the  alternate  display;
  131. however, more member files fit on the  screen  and  it  works  faster  because
  132. individual member files are not accessed.
  133.  
  134.    With both displays a final summary line gives the number of matching member
  135. files found, the number of  active  members  in  the  library,  the  number of
  136. deleted members, the number of free directory entries, and the total directory
  137. entries.
  138.  
  139.    LD can be aborted anytime with  ^K, K, ^X, X,  ^C,  or C.   Except  at  the
  140. "[more]" prompt,  a  ^S  will pause the display until  another key is pressed.
  141. Pressing the space bar at any time sets LD to  "line by line"  advance (unless
  142. paging has been turned off with the P option).
  143. :3
  144.  Security  
  145.  
  146.    Complete security is assured under ZCPR3 by using the filespec as parsed by
  147. the command processor.   As  additional  security,  LBR  files with the system
  148. attribute set will be ignored if the wheel byte is off.
  149.  
  150.    For non-wheels,  the summary line shows only the number of matching members
  151. and the number of active member files.
  152.  
  153.    Non-wheels cannot access the command line options  "L"  and "F" for printer
  154. output, nor are these options shown on the  usage screen if the wheel  byte is
  155. off.  If the options are used on the command line,  no error message is given,
  156. but the printer is not accessed.   The "M" option for message  register output
  157. and the "Q" quiet mode option  are not listed on the usage screen if the wheel
  158. byte is off, but they can still be used.
  159. :4
  160.  Errors 
  161.   
  162.    On error the ZCPR3 program error flag is set as follows:
  163.  
  164.     255   no matching member files found
  165.      19   invalid option
  166.      12   insufficient memory (TPA overflow)
  167.      10   library file not found
  168.       4   library is corrupt, or no message buffer with M option
  169.       2   invalid directory
  170.  
  171.    The error handler,  if one is  running,  will  be  invoked  for all errors,
  172. except when no matching member files are found (code 255).
  173. :5
  174.  Configuration - 1/2 
  175.  
  176.    Although a large number o configuration options are available, LD should be
  177. ready to use  "as is"  for remote access systems  (RAS)  or individuals  under
  178. ZCPR3.   CP/M users should change the  configured  number  of  screen lines if
  179. their screen has more or less than  24 lines.   Sysops  for  non-ZCPR3  remote
  180. systems should also install the address of their system's wheel byte.
  181.  
  182.    Configuration changes are made with  ZCNFG  and the  accompanying  LDnn.CFG
  183. file.  If the name of the configuration file is not changed, ZCNFG will always
  184. be able to find it,  even if the name of LD is changed to something else, such
  185. as LDIR.   Full explanations for the  various  options  are  available on  the
  186. configuration help screens.
  187.  
  188.    All command line options are toggles and can be configured as the defaults.
  189. The command line options may then be used to toggle to  whatever is  the  non-
  190. default state.
  191.  Configuration - 2/2 
  192.  
  193.    The date displays can be configured  for  either  "American"  (mm/dd/yy) or
  194. "European" (dd.mm.yy) format.   The time displays can be configured for either
  195. "Civilian" (12-hour time, e.g.,  "3:21p") or  "Military"  (24-hour time, e.g.,
  196. "15:21") format.  As distributed, American date and military time are used.
  197.  
  198.    With the "M" option the number  of  matching  member  files  is  placed  in
  199. registers 18 and 19  (low byte first),  the number of  free  (unused)  library
  200. directory entries in registers  20 and 21.   The  registers used  may  also be
  201. changed.
  202. :6
  203.  LD Notes - 1/2 
  204.  
  205.    a. LD is derived from LDIR-B Version 2.2, which gives an UNARC-type display
  206.       of library directories.   Originally written by Steven Greenberg,  it is
  207.       the result of several years of continuing development  by  Bruce Morgen,
  208.       Michal Carson, Sean Sullivan,  Howard Goldstein,  and Gene Pizzetta.  LD
  209.       will be moving in  a  slightly  different  direction,  hence,  the  name
  210.       change.  The goal is to keep this program under 4K, about twice the size
  211.       of LDIR-B,  and to provide a more versatile library directory  tool with
  212.       numerous command line and configuration options, and making more extens-
  213.       ive use of Z-System facilities,  while remaining compatible with vanilla
  214.       CP/M.
  215.  
  216.    b. Vs 1.1 updates (10/25/91, Gene Pizzetta):
  217.       - Added alternate display of member names, sizes,  CRC's, and indexes in
  218.         two-columns.  
  219.       - Changed some options, added others.   Option S prints only the summary
  220.         line.   Option Q is a true quiet mode.   Option M stores the number of
  221.         matching members and free library directory entries to  message regis-
  222.         ters.   Option D checks for  embedded  dates in  crunched files before
  223.         checking library directory for dates.  
  224.  LD Notes - 2/2 
  225.  
  226.       - Restored configurable wheel byte  address for  non-ZCPR3  systems.  If
  227.         wheel is off, now shows number of  matching  and  active  members  and
  228.         suppresses display of  M  and  Q (along with L and F) options on usage
  229.         screen, although M and Q will still work.  
  230.       - In quiet mode output can be sent to the printer.  
  231.       - Top of memory calculation  is  now  less  conservative  for low memory 
  232.         applications.  
  233.       - Fixed a few  bugs,  including one that  kept  LD  from  running  under
  234.         vanilla CP/M.  
  235.       - Now invokes error handler for errors other  than  no  matching  member
  236.         files found.  
  237.