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 / BEEHIVE / ZSUS / ZSUS001.LBR / D16.LBR / D16.DZC / D16.DOC
Text File  |  1989-12-05  |  15KB  |  331 lines
  1.  
  2.                                 D
  3.                     A ZCPR3 Directory Program
  4.                            Version 1.6
  5.  
  6.          Version 1.6 and Documentation by Gene Pizzetta
  7.                          December 3, 1989
  8.                  Original Program by Hank Blake
  9.  
  10.  
  11. D has long been my favorite directory program.  It provides a 
  12. number of features not provided by other directory utilities.  
  13. The display is in lowercase, which makes it more readable to most 
  14. people.  In addition, it shows total disk capacity, the total 
  15. number of bytes used by the displayed files, the number of bytes 
  16. remaining on the disk, and the number of remaining directory 
  17. entries.  It also shows SYS, ARC, R/O, and other file attributes, 
  18. and displays files from all user areas in a single listing.  
  19.  
  20. D also sets the program error flag if no files are found that 
  21. match the file mask, if one is given, or the selected options.  
  22. It will also store the number of matching files in a ZCPR 
  23. register, if you so desire.  And D will operate quietly, if you 
  24. wish, with no screen display.
  25.  
  26. Originally written for CP/M 2.2 and above, it is designed to give 
  27. most of the information a user requires, while remaining under 4K 
  28. in size.  This version of D runs only under ZCPR3 and Z3PLUS.
  29.  
  30. Give D a little time and the value of the various features will 
  31. become obvious.
  32.  
  33. USAGE:
  34.  
  35.      D {dir:}{<{afn}.aft>} {{/}<options>}
  36.  
  37. If a drive and user or named directory is omitted, the current 
  38. drive and user is assumed.  If a filename is omitted then all 
  39. files (*.*) is assumed.  If a filetype is given without a 
  40. filename, D wildcards the filename.  If no option is given then 
  41. all non-system files are displayed.
  42.  
  43. Options must be preceded by a space and slash (/), unless a DU or 
  44. DIR specification and/or a filename or filetype is given.  
  45. Several options may be included without intervening spaces.  A 
  46. filename mask may include slashes, but if it begins with a slash 
  47. then the mask must be preceded by a DIR or DU specification, or 
  48. simply a colon.
  49.  
  50. If no files are found that match the given options or ambiguous 
  51. filename, D will set the program error flag.  That will allow to 
  52. detect the existence of particular types of files and act on 
  53. their absence or presence using the IF ERROR command.
  54.  
  55. D is re-entrant and may be used with the GO command.
  56.  
  57. The number of columns used for the display varies, depending on 
  58. the number of files, the options chosen, and the width of your 
  59. screen.
  60.  
  61. OPTIONS:  All options are specified after a space and slash.  If 
  62. two successive slashes are used, then a brief usage message is 
  63. displayed.
  64.  
  65.      A    archived files only
  66.      B    include both non-system and system files
  67.      C    comprehensive, complete file control block information
  68.      F    suppress file sizes
  69.      M    put number of matching files in registers 18 and 19.
  70.      N    no formfeeds to printer
  71.      O    read-only files only
  72.      P    send to printer
  73.      Q    quiet operation with no display
  74.      R    reset disk system
  75.      S    only system files
  76.      U    include files from all user areas
  77.      W    only read/write files
  78.      X    do not sort
  79.      Z    only non-archived files
  80.  
  81. EXAMPLES:
  82.  
  83.      A0>d b: /a     displays all the archived files from the
  84.                     current user area (0) on drive B.
  85.  
  86.      A0>d e4:       displays all non-system files from user 4 on
  87.                     drive E.
  88.  
  89.      A0>d /so       displays all the read-only system files from
  90.                     the current user area and drive (A0).
  91.  
  92.      M0>d edit:foo.*  displays all non-system files named FOO
  93.                     from the named directory EDIT.
  94.  
  95.      A0>d c23:.bar b  displays all files, both system and non-
  96.                     system, from user 23 on drive C with a file-
  97.                     type of .BAR.
  98.  
  99.      B1>d :/*.* u   displays all filenames beginning with a
  100.                     slash in all user areas of drive B (the
  101.                     default drive).
  102.  
  103. EXPLANATIONS OF OPTIONS:  Some options, particularly those that 
  104. regulate the display, are mutually exclusive.  If two or more 
  105. such options are given in the command line, generally the more 
  106. comprehensive options take precedence.  Unknown options are 
  107. ignored.
  108.  
  109.      A    Archived files only.  This filters for files with the 
  110.           Archive bit set and only those files are displayed.  
  111.           (The Archive attribute is a CP/M 3.0 feature that has 
  112.           also been implemented by ZRDOS, ZSDOS, and other 2.2 
  113.           replacements).  See also Z option.
  114.  
  115.      B    Both system and non-system files included.  This option 
  116.           turns off the system file filter and displays all files 
  117.           on the disk, both system and non-system.  System files 
  118.           are highlighted, however.  See also S option.
  119.  
  120.      C    Comprehensive file information.  Displays the complete 
  121.           directory entry for the selected files.  The files are 
  122.           unsorted but the filters work normally (the default is 
  123.           all non-system files.  All file attributes, including 
  124.           F1 through F8, are shown using highlighting on the 
  125.           corresponding characters of the filename.
  126.  
  127.      F    File sizes suppressed.  Displays files without file 
  128.           size information, resulting in a more compact display, 
  129.           with one additional column of filenames.
  130.  
  131.      M    Put number of matching files in user registers 18 and 
  132.           19.  The low byte is put in 18.  Some programs, for 
  133.           instance don't work if they have to deal with more than 
  134.           255 files.  You can detect this by checking for a non- 
  135.           zero value in register 19.  The registers used can be 
  136.           changed at the REG equate and the source code re- 
  137.           assembled.  (Remember that ZDE uses registers 16 and 
  138.           17.)
  139.  
  140.      N    No formfeeds.  If the P option is specified, this 
  141.           option causes formfeeds to be suppressed.  Without the 
  142.           P option, N has no effect.
  143.  
  144.      0    Read-only files only.  This filters for files that have 
  145.           the RO attribute set, and only those files are 
  146.           displayed.  See also W option.
  147.  
  148.      P    Printer echo.  Sends the directory to the printer, as 
  149.           well as to the screen (but there is no page pause if 
  150.           the screen fills).  Normally the printer listing is 
  151.           paged (every 4 lines less than your page length), and a 
  152.           final formfeed is sent when the listing is completed, 
  153.           but see also N option.
  154.  
  155.      Q    Quiet operation.  Suppresses the screen display, useful 
  156.           if you are using D for simple file detection with the 
  157.           error flag, or if you are using the M option, in a 
  158.           SUBMIT or ZEX batch file.  As a side effect, printer 
  159.           output is also suppressed.
  160.  
  161.      R    Reset disk system.  The disk system is reset before the 
  162.           directory is read, so that the correct disk space is 
  163.           given under CP/M 2.2 compatible systems if the disk is 
  164.           changed.  This option should not be necessary under 
  165.           CP/M Plus.
  166.  
  167.      S    System files only.  This filters out non-system files 
  168.           and displays only system files.  See also B option.
  169.  
  170.      U    All users included.  Displays files from all user areas 
  171.           of a disk in a single listing.  
  172.  
  173.      W    Read/write files only.  This option displays only 
  174.           files that are not read-only.  See also R option.
  175.  
  176.      X    Cancel sort.  The directory files is not sorted in the 
  177.           display.  This is handy to find out the order that the 
  178.           filenames appear in the directory.  Some files with 
  179.           multiple directory entries that are not sequential will 
  180.           be listed more than once.
  181.  
  182.      Z    Non-archived files only.  This filters for files that 
  183.           do not have the Archive bit set and allows you to 
  184.           determine how many files need to be backed up.  See 
  185.           also A option.
  186.  
  187. DISPLAY FEATURES:  The directory display is fairly obvious, but a 
  188. few items might need clarification.
  189.  
  190. The default filter excludes system files.
  191.  
  192. Sorting the file entries alphabetically by filename is also a 
  193. default.  Files, sorted or unsorted, are displayed in a columnar 
  194. format.
  195.  
  196. System files are displayed in alternate video (dim or reverse), 
  197. when the B or S option is used, if alternate video is supported 
  198. by your TCAP.
  199.  
  200. Following the file size is either a k (for kilobytes) or an r 
  201. (for a read-only file).  The size is always in kilobytes, 
  202. regardless of the letter.  If the letters are uppercase (K or R) 
  203. then the corresponding file has the Archive bit set.
  204.  
  205. The characters in the filename display are reverse-cased.  Most 
  206. filenames will be in lowercase, but a filename in lowercase 
  207. (it's easy to do with MBASIC) is displayed in uppercase.
  208.  
  209. If a directory entry has a non-printable character in it, the 
  210. character is replaced by a question mark (?).
  211.  
  212. If the C option is used, any space characters with an attribute 
  213. bit set are replaced with an asterisk (*), so the attribute can 
  214. be displayed using dim video.
  215.  
  216. SPECIAL CONSIDERATIONS:  Be cautious when the disk in question is 
  217. read-only.  Incredibly spurious results can occur, especially 
  218. under CP/M 3.0.  For that reason D will display a "Disk is Read 
  219. Only" message, so you can treat the results with a grain of salt.  
  220. You can also use the R option (reset disk system) to eliminate 
  221. the problem.
  222.  
  223. If you use CP/M 3.0, you may have noticed that single-letter 
  224. program names followed by the name of a file on another disk 
  225. confuses the CCP.  That is, if you type (from the prompt)
  226.      A>d b:*.bar
  227. the CCP can't find D and reports an error.  This is a bug in the 
  228. CCP and there are public domain patches available to fix it.  If 
  229. your CCP isn't patched, I recommend renaming single-letter 
  230. programs like D to something else under CP/M 3.0.  Try something 
  231. like DD.COM.  Or you can use any single character name above P.
  232.  
  233. CP/M 3.0 supports disk labels, which are a directory entry under 
  234. user 32.  If D is assembled with the DSKLBL label TRUE, the D 
  235. looks for a user 32 entry and, if it finds one, lists it as the 
  236. disk name just after the user/drive callout.  User 32 is not 
  237. available to D under any other circumstances.  I left this 
  238. feature in as an assembly-time option because it is probably more 
  239. useful for users of floppy drives under CP/M Plus than named 
  240. directories.  If users of CP/M 2.2 desire such labels on their 
  241. disks, they must find a way to install a directory label entry in 
  242. user 32.  Any disk utility, such as DU, could be used to do this 
  243. by modifying a null (0K) directory entry to user 32.  Only 
  244. experienced users should try this.  The regular version of D 
  245. display ZCPR3 named directories instead of disk labels.
  246.  
  247. INSTALLATION:  Installation is no longer required.  The alternate 
  248. video string is determined from your TCAP.  The width and length 
  249. of your screen and the page length of your printer are determined 
  250. from your environment descriptor.
  251.  
  252. There are two assembly-time options that may be set in the source 
  253. file, however.  Set DSKLBL to True if you'd rather display CP/M 
  254. Plus disk labels, than ZCPR3 directory names.  Set REVVID to True 
  255. if you use reverse video for highlighting.
  256.  
  257. HISTORY:  The source code began as a disassembly of NEW-D.COM 
  258. using DASM 1.6 by Richard Conn and Joe Wright.
  259.  
  260. Version 1.0 -- Hank Blake -- 1984
  261.      For CP/M 2 and 3.  Source code not released.
  262.  
  263. Version 1.1 -- Gene Pizzetta -- June 25, 1989
  264.      For ZCPR3.  Source code derived from disassembly of original
  265.      COM file.  Added DU and DIR support under ZCPR3.  Added "//"
  266.      help screen.  Option delimiter changed from "[" to "/".  "G"
  267.      (specific user area) option eliminated.  Several other
  268.      cosmetic changes.
  269.  
  270. Version 1.2 -- Gene Pizzetta -- July 29, 1989
  271.      Now searches for filenames containing slashes, but not
  272.      filenames beginning with a slash unless it is preceded by a
  273.      DU or DIR specification (actually, a single colon will do).
  274.      Added R option to reset disk system.  Renamed old R option
  275.      to O option (to include only read-only files).  Added TCAP
  276.      support for dim or reverse video; no installation required.
  277.  
  278. Version 1.3 -- Gene Pizzetta -- August 21, 1989
  279.      No longer sends initial formfeed to printer; instead sends
  280.      formfeed after every 62 lines and a final formfeed after
  281.      printing directory, unless "N" option is used.  Changed
  282.      "Ext" to "Typ" in display.  Now prints ZCPR3 named directory
  283.      following DU specification, if the DSKLBL label below is set
  284.      to FALSE, otherwise looks for CP/M Plus disk label.
  285.  
  286. Version 1.4 -- Gene Pizzetta -- September 8, 1989
  287.      Horizontal lines in dim video.  Added equate for reverse
  288.      video version.  Revamped command line parser:  slash (/)
  289.      no longer required before options, if option list is second
  290.      token on the command line; and if a filetype is given, but
  291.      not a filename, the filename is automatically wildcarded.
  292.  
  293. Version 1.5 -- Gene Pizzetta -- October 6, 1989
  294.      Corrected problem with file mask, DU, and option selection
  295.      that only occurred under Backgrounder ii.  Now reads
  296.      environment to determine the number of lines on the screen,
  297.      number of screen columns, and number of lines on printer
  298.      page.  Now re-entrant for use with the "GO" command.
  299.  
  300. Version 1.6 -- Gene Pizzetta -- December 3, 1989
  301.      Now sets error flag if no matching files are found or if D
  302.      runs out of memory.  Added M option to store number of
  303.      matching files in user registers.  Added Q option to
  304.      suppress screen output.
  305.  
  306. COPYRIGHT:  The original version of D.COM is copyright (c) 1984 
  307. by Hank Blake, Source Maverick, San Diego, California.  According 
  308. to that copyright, you may use D.COM for your own purposes other 
  309. than selling it.  You may distribute it as you wish, as long as 
  310. you do not charge for the program.  D.COM may be distributed on a 
  311. disk with other programs, for which there is a copy charge only 
  312. associated with the disk.  The copy charge may not exceed US 
  313. $2.00 in 1984 dollars, however.  The author assumes no liability 
  314. whatsoever with respect to another party's usage of D.COM, your 
  315. acceptance of this statement being a prerequisite to said party's 
  316. use of the program.
  317.  
  318. The changes made since version 1.0 are numerous and are not 
  319. copyright, but they would be of little use by themselves.
  320.  
  321. If you have any suggestions, complaints, or bug reports, please 
  322. let me know.
  323.  
  324.      Gene Pizzetta
  325.      481 Revere St.
  326.      Revere, MA 02151
  327.  
  328.      Voice:  (617) 284-0891
  329.      Newton Centre Z-Node:  (617) 965-7259
  330.      Lilliput Z-Node:  (312) 649-1730
  331.