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