home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / lambda / soundpot / a / d-d1.lbr / D.DZC / D.DOC
Encoding:
Text File  |  1993-10-26  |  11.3 KB  |  274 lines

  1.  
  2. D: Display Disk/Drive Directory
  3.  
  4.     Copyright (c) 1985 by Kent Anderson, Berkeley, CA  94704
  5.     Commercial sale of this program and documentation without
  6.     written permission is prohibited.
  7.  
  8.  
  9. To run: 'D'         Displays sorted directory of files on default drive.
  10.     or: 'D <drive/user/filename>'  Displays files matching <dr/usr/file>.
  11.     or: 'D <drive/user/filename> <options>'
  12.     or: 'D $<options>'
  13.  
  14. <drive/user/filename>  - may contain wildcards ('*' and '?'): e.g. *.COM
  15.                - may be just drive/user: 'D A' will list
  16.                 files on A drive.  (To search for a
  17.                 file called 'A', put a drive code in
  18.                 front of it: e.g. 'B:A'.)
  19.                - may use 'ZCPR' format: e.g. B1 refers to
  20.                 drive B, user 1.
  21.  
  22. OPTIONS:
  23.    
  24.    Mnemonic    Function
  25. -- -----------    -------------------------------------------------------
  26. $  Options    Ignored, but used to indicate an option string with no
  27.            filename; e.g. 'D $D' lists all drives.
  28.  
  29. A  All users    ALL users, starting with user 0 or whatever user was
  30.         specified in the filename or the U option (below).
  31.  
  32. C  Clear    CLEAR screen before listing files.  (Assumes ADM3a-like
  33.         device.)
  34.  
  35. D  Drives    All active DRIVES, starting with A or specified drive.
  36.  
  37. F  File        Make a disk FILE of the directory display.  The default
  38.         filename is SD.DIR.
  39.  
  40. N  No paging    NO paging of screen output.  Otherwise, screen output
  41.         will halt every 24 lines, awaiting any keyboard input.  
  42.         Control-C will return to CP/M.
  43.  
  44. P  Print    PRINT a copy directory of the directory display.  This
  45.         option is useful for making slips of paper that can be
  46.         stored with the disk, so you can tell what's on them
  47.         without putting them in the computer.
  48.  
  49. R  Reset    RESET drives before listing (to get the correct value
  50.         for the "space available" when a disk has been changed
  51.         without doing a "Warm Boot").
  52.  
  53. S  System Files    Display SYSTEM files.  Otherwise they are omitted.
  54.  
  55. T  Top        Put summary line at TOP of display.  Otherwise the
  56.         summary line, which gives the number of files, space
  57.         used, and space free, appears at the bottom.
  58.  
  59. Un User n    Start search with USER n: e.g. U8 starts with user 8.
  60.         There must be no space between the 'U' and the number.
  61.  
  62. OPTIONS, Cont.
  63.  
  64.    Mnemonic    Function
  65. -- -----------    -------------------------------------------------------
  66. V  Version    Show VERSION number.  Displays a line identifying
  67.         the program and its release date, so you can see whether
  68.         your version is the latest one.
  69.  
  70. Z  ZCPR        "ZCPR" format, combining drive and user: e.g. 'A0', 'B10',
  71.         'M15'. Setting the 'Z' option causes the drive/user to
  72.         appear at the beginning of each line of file information.
  73.         It also causes the user number to appear with the drive
  74.         code, even with user 0.  The 'Z' option is set
  75.         automatically whenever the input contains a filename
  76.         that uses ZCPR format.  It is also set if the 'A' or 'U'
  77.         option is used.
  78.  
  79. +  Plus        When used with 'F' option, ADDS display to previously-
  80.         existing disk file, instead of making a new disk file.
  81.         The default makes a new disk file.
  82.  
  83. !  Only!    Resets all of the above options.  This option is used
  84.         with '=' option, below, to define exactly the options
  85.         you want set in a new version of the directory program.
  86.  
  87. 2  20-column    20-column, 40-column, 60-column, or 80-column format.
  88. 4  40-column    Adjusts the display for different screen sizes.  Lists
  89. 6  60-column    files in 1, 2, 3, or 4 columns, respectively.  The
  90. 8  80-column    default is 4 columns ('8' option).  NOTE: 'D $2FN'
  91.         makes a disk file that can easily be made into an
  92.         annotated directory listing with your text editor.  
  93.  
  94. /<FileName>    Changes the name of the file made by the 'F' option.
  95.         The default is SD.DIR.
  96.  
  97. =<ProgName>    Makes a new version of the directory program itself,
  98.         with default options as specified.  If the filetype is
  99.         omitted, it will be set to '.COM'.  For example:
  100.             'D $!T4 =A:D'
  101.         will make a program called 'D' on the A drive, which
  102.         will display the summary line above the files and will
  103.         list the files in two columns.  (Note the use here of
  104.         the '!' option to guarantee that all options except T
  105.         and 4 are reset.  Also note that we could not have
  106.         identified the new program as just 'D'; this would have
  107.         been interpreted as a drive code without a filename,
  108.         which is invalid in this case.)
  109.  
  110.  
  111. Note that filenames must have a space separating them from any further
  112. options.  Everywhere else (except after the 'U' option) spaces are
  113. insignificant.  Upper case/lower case is also insignificant, of
  114. course.
  115.  
  116.  
  117. EXAMPLES:
  118.  
  119. D        Display all non-system files on default drive.
  120. D $R        Same as above, but reset drives first (if disk was changed).
  121. D $S        Display all files on default drive (including system files).
  122. D A        Display all non-system files on A drive.
  123. D A:*.COM    Display .COM files on A drive.
  124. D *.??M        Display files with 'M' in last character of filetype.
  125. D $D        Display all non-system files for current user on all drives.
  126. D $ADS        Display all files for all users on all drives.
  127. D $P        Display all non-system files with copy to printer.
  128. D B CRV        Display files on drive B after clearing CRT, resetting
  129.             drives, and showing version date.
  130. D $4TZ        Display files on default drive, use 40-column format,
  131.             put summary line at top of display, and use
  132.             ZCPR format.
  133. D *.MSS F+/MSSFILES.MSS
  134.         Display .MSS files on default drive, append display to
  135.             disk files named MSSFILES.MSS.
  136.  
  137.  
  138. DISCLAIMER
  139.  
  140.     While this program has been carefully tested, no warranty is
  141. offered, and no liability is assumed for any loss or damage caused, or
  142. alleged to be caused, directly or indirectly by this program.  This
  143. includes, but is not limited to, any interruption of service, loss of
  144. business, anticipatory profits, or consequential damages resulting
  145. from the use of this program.
  146.  
  147. COPYRIGHT NOTICE
  148.  
  149.     This program has been contributed to non-profit users' groups
  150. in support of their activities and to facilitate its distribution.  It
  151. is not fair for profit-seeking enterprises to make money distributing
  152. such material without paying the authors.  Consequently, although this
  153. program has been placed in the public domain, I retain all copyrights to
  154. it.  This program and its associated documentation MAY NOT BE SOLD BY
  155. ANY PARTY except non-profit users' groups, unless specifically
  156. authorized by the author, Kent Anderson, in writing, prior to sale of
  157. the first copy.  Furthermore, this program MAY NOT BE INCLUDED IN ANY
  158. PACKAGE FOR SALE, even if this program is indicated as being "in the
  159. public domain".  All of the above applies to both the original and any
  160. derived or modified copies of the original.  Any modified copies MUST
  161. NOT have the copyright notice violated or altered.
  162.  
  163.     Please report any copyright violations to the author.  I'm in
  164. the phone book.
  165.  
  166.                     Kent Anderson
  167.                     34 Panoramic Way
  168.                     Berkeley, CA  94704
  169.  
  170. CONTRIBUTIONS
  171.  
  172.     I spent a lot of effort to make this program as useful, tiny,
  173. flexible, and polished as possible, and I hope and believe you find that
  174. it makes your computer better.  If this program is valuable to you,
  175. please feel free to tell me so, by sending a contribution (say, $15, or
  176. whatever you think it's worth) to the above address. Suggestions for
  177. enhancement would also be appreciated.
  178.     
  179.  
  180. OVERVIEW
  181.  
  182. This 2k directory program contains almost all of the features of SD98
  183. (an advanced version of an earlier public-domain directory program), but
  184. it uses less than half the disk space. It is also somewhat easier to use
  185. and more flexible:
  186.  
  187.     - Drive/user can be specified without a colon:
  188.         'D A' will list files on the A drive.
  189.         'D B1' will list files on drive B, user 1.
  190.     - '$' need not precede options if a filename is used:
  191.         'D B5 R' will list files on drive B, user 5
  192.         after resetting drives.
  193.     - Format of display is flexible: see T,Z,2,4,6, and 8 options.
  194.     - CAN CREATE NEW VERSIONS OF ITSELF, with different default
  195.         options: see '=' option.
  196.     - 'No files' message echoes the filename sought, if one was
  197.         given.
  198.     - Error message reports the point at which the problem was
  199.         detected in the input.
  200.     - Can create a useful cataloging program.  See below.
  201.      - Contains '2' option, listing files and sizes in a single
  202.         column: convenient for making annotated directory
  203.         listings.
  204.  
  205. Differences between D and SD98:
  206.     - D is 2k; SD98 is 5k.
  207.     - D has no library option.
  208.     - Default version of D differs slightly in the format of
  209.         the summary line and in its option settings.  Most
  210.         of these differences can be overcome by changing
  211.         the default options: 'D $!TZ+=SD99'.
  212.  
  213.  
  214.  
  215. Note that there is a tradeoff for making it easier to specify
  216. drive/user: while you don't have to type a colon to specify a drive
  217. or a drive/user combination ('B:' or 'C4:'), if you actually ARE looking
  218. for a file called 'B' or 'C4', you can't just type 'B' or 'C4'. 
  219. Instead--in these special cases--you MUST specify the drive/user: e.g.
  220. 'B:B' or 'A:C4'. Similarly, since '$' in the first character of the
  221. filename signifies an option list to follow, if you really do want a
  222. list of files with names beginning with '$', put a drive code in front
  223. of the filename.
  224.  
  225.  
  226.  
  227.  
  228. D can also produce a simple but serviceable cataloging program:
  229.         D A RF+/CATALOG.DOC =B:C
  230. will make a program called 'C' (for Catalog) on the B drive; the
  231. program will reset drives, display all files on the A disk, and append
  232. the listing to the file 'CATALOG.DOC'.  You can then feed disks one at
  233. a time into the A drive, type 'C' and <CR>, and produce a listing of
  234. the contents of your disks.  This is not as fancy as real cataloging
  235. programs, but it may be perfectly satisfactory.  The main thing your
  236. catalog will lack that fancier systems provide is a cross-referenced
  237. list of files.  But you can simply use your text editor to search the
  238. CATALOG.DOC to find what disk(s) it appears on.
  239.  
  240. Helpful hint: put a dummy filename on each disk that has a '-' in the
  241. first character of the name and a three-digit number in the filetype. 
  242. This names and numbers each disk, and the '-' in the filename will
  243. make it appear first in the directory display.  Give your disks names
  244. like '-EDITDSK.002' or '-CH1.034'.  Write the disk number on the
  245. label. To put these filenames on the disk without using any space, use
  246. the SAVE command: e.g. 'SAVE 0 -EDITDSK.002'.  This creates a directory
  247. entry, but uses no disk space.
  248.  
  249. Note that 'D A D' may be easily remembered as "Display All Drives".
  250.  
  251.  
  252. ASSUMPTIONS, LIMITATIONS, AND HOOKS FOR FURTHER CUSTOMIZATION:
  253. 1. Requires Z80 processor, at least 16k RAM, and CP/M version 2.2 or
  254.     later.
  255. 2. The maximum number of files for any user on any drive is 256.
  256. 3. Assumes the command tail is passed through the CP/M buffer at 0080h,
  257.     and that it is already capitalized, as per the CP/M standard.
  258. 4. Addresses for modification:
  259.     Value              Location
  260.     -------------------   --------
  261.     ClearString        08F9  String that clears CRT.  Maximum 6
  262.                     characters, followed by '$' (24h).
  263.                     Default: 1Ah, for ADM3-like device.
  264.     FenceChar        08F7  Character that separates entries
  265.                     on the same line.  Default: '|'.
  266.     LinesPerScreen - 1      05E2  Limit used in "paging" output to CRT.
  267.                     Default: 23 (17h), i.e. 24 lines.
  268.     OptionChars        08D8  List of valid option characters.
  269.                     By setting any of these to 00h,
  270.                     the corresponding option can be
  271.                     disabled. 
  272.  but uses no disk space.
  273.  
  274. Note that