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 / ENTERPRS / CPM / UTILS / S / SD-81.ARK / SD-81.DOC < prev    next >
Text File  |  1989-09-27  |  9KB  |  175 lines
  1.  
  2.               v81 04/04/84
  3.  
  4.           The SD Super Directory Program
  5.  
  6.      This documentation file concerns SD-81.ASM.  This is a signifi-
  7. cant upgrade of the standard "super-directory" program that most RCP/M
  8. systems are now using as their "DIR" executor.
  9.  
  10.      The most significant improvement is the support of the DU: form for
  11. drive-spec, similar to that used by ZCPR2 and its various utilities.
  12. This is concurrent with the $U option.    The filename of the file for the
  13. $F option has been altered to SD.DIR, as it was originally.  Other op-
  14. tions such as multi-drive search remain as before.  Now, in place of the
  15. $U option, you may specify the Drive/User with the filename, such as:
  16. SD A1:*.*, SD 1:*.*, SD B:FN.FT, SD B4:FN.FT $AD, etc.    You may still
  17. use the $U option if desired, although it seems the DU: form is a much
  18. easier and more logical method.  File lengths over four megabytes are
  19. read correctly.
  20.  
  21.      Files  may be  shown in vertical or horizontal listings, although
  22. this must be set when the program is assembled for a particular system.
  23. The distribution copy is set for vertical alphabetization since most
  24. non-RCPM users will likely prefer this presentation.  (SYSOPs will need
  25. to set a number of equates and reassemble the file in any event.)
  26.  
  27.      SD-81 has support for .LBR files, (an 'L' option to list their
  28. member files); and support for the NZCPR/ZCPR2 "WHEEL" byte option.
  29. (SD-81.COM set up for ZCPR2 use with WHEEL at 3EH.)  Size of library
  30.  member files  are shown in 'k'.
  31.  
  32.      The basic operation of SD is as in previous releases.  You merely
  33. type "SD", followed by an optional ambiguous or nonambiguous filename
  34. (as you would with the CCP directory command).    Omitting the filename
  35. (i.e., "SD <cr>"), will be interpreted as "SD *.*".  Similarly, "SD A:"
  36. would imply "SD A:*.*" and "SD B:" would  imply "SD B:*.*".
  37.  
  38.      In addition to the filename option, up to 11 command line options
  39. may be specified.   Option fields are preceded by a single dollar sign
  40. as with most Digital Research programs such as MAC, and may be essen-
  41. tially free-form in format.  Example:  SD B:$ADnU0fpS.    Spaces within
  42. the option field are insignificant i.e., "$ SADN U0FP" is equivalent to
  43. "$  S A D N  U0  F P").  The only exception concerns the "USER" option
  44. which will be explained later.
  45.  
  46.      Users should also be aware of two restrictions on the command line
  47. format.  SD scans the entire command line for a dollar sign preceded by
  48. at least 1 blank to delimit the beginning of the option field.    Forthis
  49. reason, invoking SD with a command line such as:  "SD $ $AR" is illegal,
  50. since SD will consider the first dollar sign to be the option field de-
  51. limiter.  If you need to specify a filename whose first  character is a
  52. dollar sign precede it with a drive code as in "SD A:$ $AR".  In this
  53. instance, SD will consider the first dollar sign insignificant as it is
  54. not preceded by a blank.
  55.  
  56.      Starting with SD-75 there is an assembly time option which, if set,
  57. allows the use of options without requiring the filename to be preceded
  58. with a drive code so long as you wish to look on the default drive.
  59.  
  60.      You give up the ability to specifically search for a filename whose
  61. name begins with a '$'.  However, such files will be listed, along with
  62. others, if the command line "SD $CU3" (or any other options) were speci-
  63. fied.  The "COM" file is configured with this option set.   Setting the
  64. option to 'NO' and reassembling will cause operation to revert to that
  65. of previous versions (see paragraph above).
  66.  
  67.      The second restriction is that command line options may be specified
  68. once and only once per invocation.   That is, "SD A:$SDS" would be il-
  69. legal since the 'S' option is specified twice.  This shortcoming is due
  70. to the fact that options can be made into defaults at assembly time.
  71. Note that if an option is made default, with zero as option flag, it
  72. cannot be specified without generation an error message.  The eleven re-
  73. cognized options:
  74.  
  75.   "S" - system option:    System files will be included in the
  76.     output    rather than being suppressed.
  77.  
  78.   "F" - file  option:  The directory output  will be echoed to
  79.     a disk file named "SD.DIR" on the DEFAULT drive.
  80.     If this name already exists then the directory output
  81.     will be APPENDED to the end of the file.  "SD.DIR"
  82.     will otherwise start as a new file.  The append fea-
  83.     ture allows you to build up one massive file on the de-
  84.     fault drive containing the directories of all of your
  85.     disks, without having to concantenate a swarm of indi-
  86.     vidual directory  files.  If you plan to use this fea-
  87.     ture often,it will be simpler for you to have a dedi-
  88.     cated version  on  your  MAST.CAT disk with  AUTOR set
  89.     'YES'.  The advantage of this is that you can work thru
  90.     a pile of disks without having to CTL-C or specify the
  91.     'R' option every time you SD a new disk.  Failing to do
  92.     this will result in the allocation  vector being inval-
  93.     id, and FREE size will be wrong.
  94.  
  95.   "U" - user option:  Allows the specification of the user num-
  96.     ber for the directory of the form "Uxx" where the user
  97.     # is greater than 0, but not greater than a specified
  98.     value not to exceed 15.  The user option specification
  99.     will be illegal if the user # is out of range, omitted,
  100.     or if 'U' is specified on a pre-CP/M 2 system.  Since
  101.     the user option requires a parameter (i.e., the user
  102.     number), the user number must immediately follow the 'U'
  103.     option on the command field.  That is, "U1" is legal,
  104.     but "U    1" is not.  In this respect, the 'U' option
  105.     differs from the other options in that embedded spaces
  106.     ARE significant.
  107.  
  108.   "A" - all users:  Causes SD to display directories of all
  109.     user areas starting at the user area specified in the
  110.     'U' option or, if the 'U' option is omitted, user area
  111.     0 and continuing up through the MAXUSR value from the
  112.     LODRV-HIDRV table.  (If ZPR2/WHLUSR=TRUE and the WHEEL
  113.     byte set, 0-MXZUSR.)
  114.  
  115.   "L" - LBR list option:  Allows for listing of ".LBR" file
  116.     members.  ".LBR" file members are shown followed by
  117.     their length  in 'k'.  The total length of the entire
  118.     library is also shown.
  119.  
  120.   "V" - If included, SD version number is displayed.
  121.  
  122.   "C" - If  included, clear  screen  performed before directory
  123.     information is displayed.
  124.  
  125.   "N" - no page  option:  Unconditionally disables the page
  126.     pause option.  Useful when running SD in the 'F' and/or
  127.     'A' modes when you don't want the page prompt slowing
  128.     you  down.  SD-81 will not put the page-pause prompt
  129.     into the output file or to printer if either enabled.
  130.  
  131.   "P" - printer option:  Forces all console output to be echoed
  132.     to the CP/M list device, with the most significant bit
  133.     set to 0.
  134.  
  135.   "D" - all disk option:  Allows SD to search all disk drives
  136.     on-line starting with the disk drive specified or im-
  137.     plied with the command line filename.  For example,
  138.     "SD B:$D" will result in SD searching all drives begin-
  139.     ning with drive B.  "SD $D" will result in SD searching
  140.     all drives automatically beginning with the A drive,
  141.     regardless what drive you started on.
  142.  
  143.   "R" - Reset disk system:  A disk system reset is done before
  144.     directory information is accumulated.
  145.  
  146.      If an unrecognized option (or illegal user option specification) is
  147. detected, then the command line will be played back to the console up to
  148. the point where the error was detected.  However, if the REPERR option
  149. is disabled, then SD will keep its mouth shut and ignore everything on
  150. the command line past the illegal field.  In this situation, an illegal-
  151. ly specified user number would default back to the current user number.
  152. The option of DISABLING error reporting was included primarily for sys-
  153. tems with hidden doors and secret passageways.    Shooting off rockets and
  154. clanging bells everytime a twit starts "experimenting" just calls atten-
  155. tion to the fact that there really IS something behind that hollow-
  156. sounding  wall after all.
  157.  
  158.      As an added convenience, it is possible to "hard-wire" some or all
  159. of the command line options.  For example, if you want SD to ALWAYS list
  160. system files, you can do that.    For details, see the comments preceding
  161. the option field lookup table in the assembler source file.
  162.  
  163.      Finally, if the all-disk and/or all-user options are enabled, it may
  164. be  desirable to restrict searches.  To facilitate this, a table is in-
  165. cluded in SD (beginning at label "LODRV" and continuing through "HIDRV").
  166. The table consists of a single byte for each drive to be searched begin-
  167. ning with 'A'.  Each byte may be in the range of 0-15 mod 15 and defines
  168. the highest user number that SD will search for that particular drive.
  169. The highest drive number to search is defined by the length of the table.
  170. If four DBs are present between LODRV and HIDRV, then drives A-D can be
  171. searched.  The source file includes the LODRV-HIDRV table in its maximum
  172. configuration for 16 drives.  However, delete DBs referencing drives that
  173. aren't available on your system.  Although SD will intercept attempts to
  174. search non-existant drives, there really isn't any point in allowing SD
  175. to always search drive C when you only have