home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / znode3 / uploads / z3help43.lbr / D1.HZP / D1.HLP
Encoding:
Text File  |  1991-11-13  |  15.4 KB  |  300 lines

  1. ;
  2.                                      D.COM                                    
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5.                4k (30)   D10B  1.8        Gene Pizzetta 3/91       Z3COM4
  6.  
  7.   1- Syntax/Options  2- Installation  3- Notes  4- History  5- Examples/Use   
  8.  
  9.    D provides a number of features not  provided by other directory utilities.
  10. The display is in lowercase, which makes it more readable to most people.   It
  11. shows total disk capacity,  total number of bytes used by the displayed files,
  12. number of bytes remaining on disk,  and number of remaining directory entries.
  13. It also shows  SYS,  ARC,  R/O,  and other file attributes, and displays files
  14. from all user areas in a single listing.  It sets the program error flag if no
  15. files are found matching a given file mask,  and will also store the number of
  16. matching files in a  ZCPR  register,  if you  so  desire.   And D will operate
  17. quietly, if you wish, with no screen display.  All in a size under 4k.
  18.  
  19.    D  was originally written for CP/M 3.0,  but it has  been revamped  to work 
  20. with version 2.2 under ZCPR3.3+.  Original program by Hank Blake (1984).
  21. :1
  22.     Syntax   D {dir:}{{afn}.aft} {{/}<options>}
  23.  
  24.    If a DU or DIR is omitted,  the current drive and user are assumed.   If  a
  25. filename is omitted then  all files (*.*) is assumed.   If a filetype is given
  26. without a filename, D wildcards the filename.   If no option is given then all 
  27. non-system files are displayed.
  28.  
  29.    Options must be  preceded by  a  space and  slash (/),  unless  a DU or DIR 
  30. specification and/or  a filename or filetype is given.  Several options may be
  31. included without intervening spaces.  A filename mask may include slashes, but
  32. if it  begins with  a slash,  then the  mask must  be preceded by  a DIR or DU 
  33. specification, or simply a colon.
  34.  
  35.    If no files are found that match the given options or ambiguous filename, D
  36. will set the program error flag.   That will allow to  detect the existence of
  37. particular types of files and  act on their absence or presence  using  the IF
  38. ERROR command.
  39.  
  40.    D is re-entrant and may  be  used  with  the  "GO" command.   The number of
  41. columns used for the  display varies,  depending  on the number of files,  the
  42. options chosen, and the width of your screen. 
  43.  
  44.  
  45.     Options   A    archived files only
  46.               B    include both non-system and system files
  47.               C    comprehensive, complete file control block information
  48.               F    suppress file sizes
  49.               M    put number of matching files in registers 18 and 19
  50.               N    no screen paging, no formfeeds to printer
  51.               O    read-only files only
  52.               P    send to printer
  53.               Q    quiet operation with no display
  54.               R    reset disk system
  55.               S    only system files
  56.               U    include files from all user areas
  57.               W    only read/write files
  58.               X    do not sort
  59.               Z    only non-archived files
  60.  
  61.    All options are specified  after  a space  and slash.   If  two  successive
  62. slashes are used, then a brief usage message is displayed.
  63.  Explanations of Options - 1/5 
  64.  
  65.    Some options,  particularly those that  regulate the display,  are mutually
  66. exclusive.   If two  or  more  such  options  are  given in  the command line, 
  67. generally the more  comprehensive  options take precedence.   Unknown  options 
  68. are ignored.
  69.  
  70.      A    Archived files only.   This filters for files  with the  Archive bit 
  71.           set and only those files are displayed.  (The Archive attribute is a
  72.           CP/M 3.0 feature that has also been implemented by ZRDOS,  ZSDOS and 
  73.           other 2.2 replacements).  See also Z option.
  74.  
  75.      B    Both system and  non-system files included.   This option turns  off 
  76.           the system file filter and displays  all files on the disk,  whether 
  77.           they are  system  or  non-system.   System  files  are  highlighted, 
  78.           however.  See also S option.
  79.  Explanations of Options - 2/5 
  80.  
  81.      C    Comprehensive  file  information.   Displays the  complete directory 
  82.           entry for the selected  files.   The  files  are  unsorted  but  the 
  83.           filters  work  normally (the default is all  non-system files.   All 
  84.           file attributes,  including  F1  through  F8,  are shown using high-
  85.           lighting on the corresponding characters of the filename.
  86.  
  87.      F    File sizes suppressed.   Displays files without  file  size informa-
  88.           tion, resulting in  a  more compact  display,  with  one  additional
  89.           column of filenames.
  90.  
  91.      M    Put number of matching files in user registers  18 and 19.   The low
  92.           byte is put in 18.   Some programs, for instance, don't work if they
  93.           have to deal with more  than  255 files.   You  can  detect  this by
  94.           checking for a  non-zero value in register 19.   The  registers used
  95.           can be changed with ZCNFG.  (Remember that ZDE uses registers 16 and
  96.           17.)
  97.  Explanations of Options - 3/5 
  98.  
  99.      N    No paging, formfeeds.  This option turns off screen paging.  If the
  100.           P option is specified,  this  option  also  causes  formfeeds to be
  101.           suppressed.  (Screen paging is always turned off if the P option is
  102.           given.)
  103.  
  104.      O    Read-only  files  only.   This filters for  files  that  have the RO 
  105.           attribute set, and only those files are displayed.   See also the  W 
  106.           option.
  107.  
  108.      P    Printer echo.  Sends the directory to the printer, as well as to the
  109.           screen (but there is  no page pause if the screen fills).   Normally 
  110.           the printer listing is  paged (every 4  lines  less  than  your page 
  111.           length) and a  final formfeed is sent when the listing is completed, 
  112.           but see also the N option.
  113.  
  114.      Q    Quiet operation.  Suppresses the screen display, useful if your are
  115.           using D for simple file detection with the error flag, or if you are
  116.           using the M option, in a SUBMIT/ZEX batch file.   As a  side effect,
  117.           printer output is also suppressed.
  118.  Explanations of Options - 4/5 
  119.  
  120.      R    Reset disk system.  The disk system is reset before the directory is
  121.           read, so that the correct disk space is given under CP/M 2.2 compat-
  122.           ible systems if the  disk is changed.   This option  should  not  be 
  123.           necessary under CP/M Plus.
  124.  
  125.      S    System files only.   This filters  out non-system files and displays 
  126.           only system files.  See also the B option.
  127.  
  128.      U    All users included.  Displays files from all user areas of a disk in
  129.           a single listing.  
  130.  
  131.      W    Read/write files only.  This option displays only files that are not
  132.           read-only.  See also R option.
  133.  
  134.      X    Cancel sort.   The directory files is  not  sorted  in  the display.  
  135.           This is handy to find out the order that the filenames appear in the
  136.           directory.   Some files with multiple directory entries that are not 
  137.           sequential will be listed more than once.
  138.  Explanations of Options - 5/5 
  139.  
  140.      Z    Non-archived files only.   This filters  for files that  do not have 
  141.           the Archive bit set and allows you to  determine how many files need 
  142.           to be backed up.  See also the A option.
  143. :2
  144.  Installation 
  145.  
  146.    Installation is no longer required.   The alternate video string is determ-
  147. ined from your TCAP.   The width and length of your screen and the page length 
  148. of your printer are determined from your environment descriptor.
  149.  
  150.    Three configuration options are provided, however, that may be changed with
  151. ZCNFG.   One option allows display of CP/M Plus  disk labels  instead of named
  152. directories.  Another option makes the screen display look better on terminals
  153. that use reverse video highlighting.   Lastly,  the registers in which D saves
  154. the matching file count can be changed from the default.
  155. :3
  156.  D Notes - 1/4 
  157.  
  158.    a. D vs 1.7 as distributed is designed to use  dim video highlighting.   If
  159.       your TCAP uses reverse video  highlighting  the  display  will  not look
  160.       right until you use ZCNFG and answer yes  to the  reverse  video option.
  161.       If you use  CP/M Plus and you  would like D to look for and display CP/M
  162.       Plus disk labels, instead of ZCPR3 named directories, then answer yes to
  163.       the disk label option.  Because of these configuration options, distrib-
  164.       uting four separate versions of D is no longer necessary.
  165.  
  166.    b. DISPLAY FEATURES:   The directory display is fairly obvious,  but  a few 
  167.       items might need clarification.  
  168.  
  169.       - The default filter excludes system files.
  170.       - Sorting the file entries alphabetically by filename is also a default.
  171.         Files, sorted or unsorted, are displayed in a columnar format.
  172.       - System files are  displayed  in  alternate  video  (dim  or  reverse), 
  173.         whether the B or S option is used,  if alternate video is supported by
  174.         your TCAP.
  175.  D Notes - 2/4 
  176.  
  177.       - Following the file size is  either  a k (for kilobytes) or an r (for a 
  178.         read-only file).   The size is  always in kilobytes, regardless of the 
  179.         letter.   If the letters are uppercase (K or R) then the corresponding 
  180.         file has the Archive bit set.
  181.       - The characters in the filename display are reverse-cased.  Most 
  182.         filenames will be in lowercase, but a filename in lowercase (it's easy 
  183.         to do with MBASIC) is displayed in uppercase.
  184.       - If a directory entry has a non-printable character in it, the 
  185.         character is replaced by a question mark (?).
  186.       - If the C option is  used,  any space characters with  an attribute bit
  187.         set  are replaced  with  an  asterisk (*),  so  the  attribute  can be 
  188.         displayed using dim video.
  189.  D Notes - 3/4 
  190.  
  191.    b. SPECIAL CONSIDERATIONS:  Be cautious when the  disk in question is read-
  192.       only.  Incredibly spurious results can occur, especially under CP/M 3.0.
  193.       For that reason D will display a "Disk is Read Only" message, so you can 
  194.       treat the results with a  grain of salt.   You can also use the R option
  195.       (reset disk system) to eliminate the problem. 
  196.  
  197.      - If you use CP/M 3.0,  you may have noticed  that  single-letter program 
  198.        names followed by the name of  a file on another disk confuses the CCP.  
  199.        That is, if you type (from the prompt)  A>d b:*.bar  the CCP can't find 
  200.        D and reports an error.   This is a bug in the CCP and there are public 
  201.        domain patches available to  fix it.   If  your  CCP  isn't  patched, I 
  202.        recommend renaming  single-letter  programs  like  D  to something else 
  203.        under CP/M 3.0.   Try something like DD.COM.  Or you can use any single 
  204.        character name above P.
  205.  D Notes 4/4 
  206.  
  207.      - CP/M 3.0 also supports disk labels,  which are  a directory entry under
  208.        user 32.   D can be configured to look for a user  32  entry and, if it
  209.        finds one,  list it as the disk name just after the user/drive callout.
  210.        User 32 is not available to  D  under any  other  circumstances.   This
  211.        feature is probably more useful for users of floppy drive-based systems
  212.        under CP/M Plus than would be named directories.   If users of CP/M 2.2
  213.        desire such labels on their  disks,  they  must find a way to install a
  214.        directory label entry in user 32.   Any disk utility, such as DU, could
  215.        be used to do this by modifying a null (0K) directory entry to user 32.
  216.        Only experienced  users  should  try  this.   The  regular version of D
  217.        displays ZCPR3 named directories instead of disk labels.
  218. :4
  219.  History - 1/4 
  220.  
  221.    a. Vs 1.8 updates (3/3/91, Gene Pizzetta):
  222.       - Option N now turns off screen paging, in addition to turning off form-
  223.         feeds if P option is selected.  
  224.       - Also converted source to Zilog mnemonics.
  225.       
  226.    b. Vs 1.7 updates (Gene Pizzetta 9/90)
  227.       - Nobody ever reported it, but I discovered it myself:  the U option was
  228.         not displaying files in users above 15.  It does now.  
  229.       - Added configuration bytes for CP/M Plus disk label usage,  for reverse
  230.         video selection,  and  for register usage  (separate  versions and re-
  231.         assembly no longer required).   These three configuration bytes can be
  232.         changed using ZCNFG.
  233.       - Changed all possible jumps to relative jumps, saving 80 bytes.
  234.  
  235.    c. Vs 1.6 updates (Gene Pizzetta 12/89)
  236.       - now sets error flag if no matching files are found or if D runs out of
  237.         memory.
  238.       - adds M option to store number of matching files in user registers.
  239.       - adds Q operation to suppress screen output.
  240.  History - 2/4 
  241.  
  242.    d. Vs 1.5 updates (Gene Pizzetta 10/89)
  243.       - corrected problem with file mask,  DU, and options selection that only
  244.         occurred under BGii.  
  245.       - now needs environment to determine nr of lines on screen, nr of screen
  246.         columns, and nr of lines on printer page.
  247.       - now re-entrant for use with "GO" command.
  248.  
  249.    e. Vs 1.4 updates (Gene Pizzetta 9/89)
  250.       - horizontal lines in dim video.
  251.       - added equate for reverse video version.
  252.       - revamped command l ine parser:  slash (/) no  longer  required  before
  253.         options,  if option list is second token on the command line; and if a
  254.         filetype is given,  but not a filename,  the filename is automatically
  255.         wildcarded.  
  256.  History - 3/4 
  257.  
  258.    f. Vs 1.3 updates (Gene Pizzetta 8/89)
  259.       - no longer sends initial formfeed to printer,  but sends formfeed after
  260.         every 62 lines and  a final formfeed after printing directory,  unless
  261.         "N" option is used. 
  262.       - changed "Ext" to "Typ" in display.
  263.       - now prints  ZCPR3 named dir following  du spec,  if  the  DSKLBL label 
  264.         below is set to FALSE, otherwise looks for CP/M Plus disk label.
  265.  
  266.    g. Vs 1.2 updates (Gene Pizzetta, 7/89)
  267.       - now searches for filenames containing slashes, but not ones begginning
  268.         with a slash unless it is preceded by a DU or DIR spec 
  269.       - added R option to reset disk system
  270.       - renamed old R option to O option.  
  271.       - added TCAP support for dim or reverse video; no installation required
  272.  
  273.    h. Vs 1.1 updates (Gene Pizzetta, 6/89)
  274.       - added du/dir support for ZCPR3, "//" help screen.
  275.       - option delimiter changed  from "[" to "/".   "G" (specified  user area
  276.         option eliminated)
  277.  History - 4/4 
  278.  
  279.    i. Vs 1.0 - Hank Blake (84)
  280.      For CP/M 2 and 3.  Source code not released.
  281. :5
  282.  Examples of Use 
  283.  
  284.    A0>d b: /a       displays all the  archived files from the current user area 
  285.                     (0) on drive B.
  286.  
  287.    A0>d e4:         displays all non-system files from user 4 on drive E.
  288.  
  289.    A0>d /so         displays all the  read-only system  files from  the current 
  290.                     user area and drive (A0).
  291.  
  292.    M0>d edit:foo.*  displays  all non-system  files named  FOO  from  the named
  293.                     directory EDIT.
  294.  
  295.    A0>d c23:.bar    displays all files, both system and non-system, from user
  296.                     23 on drive C with a filetype of .BAR.
  297.  
  298.    B1>d :/*.* u     displays all filenames beginning with a slash in all user
  299.                     areas of drive B (the default drive).
  300.