home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / lambda / soundpot / p / sd-60.lbr / SD-60.DZC / SD-60.DOC
Encoding:
Text File  |  1993-10-25  |  11.4 KB  |  258 lines

  1.  
  2.  
  3.                     The SD Directory Program
  4.  
  5.      Thi≤ádocumentatioεáfilσá concern≤á SD-60.AS═á &á SD-60.COM,
  6. version   6.0  (as  of  August 25, 1983).   Version  6.0   is  a
  7. significant  upgrade  of  the standard "super-directory" program
  8. that most RCP/M systems are  now  using as their "DIR" executor.
  9. SD-60 implements many new features  over version 3, and has been
  10. tested prior to release. (A few bugs have been fixed, also.)
  11.  
  12.      The most significant  difference  between  version  6.0 and
  13. version  3.X  concerns  the  ability  of SD to search a range of
  14. drives and/or user areas for a specified  file.  This capability
  15. is patterned after FILEFIND, but is significantly more useful in
  16. that  SD will report the sizes of files matched.    A  new  BDOS
  17. intercept  routine  has been added, which although more involved
  18. than  the FILEFIND method,  is  more  generally  applicable  and
  19. should  run "as-is" on most CP/M systems.  Thus, by using SD-60,
  20. the use of a separate FILEFIND program should be unnecessary.
  21.  
  22.      SD-60  ha≤ suppor⌠ fo≥  .LB╥ files¼á (aε "Ló optioε t∩ lis⌠ ì
  23. thei≥á membe≥á files)╗á anΣ suppor⌠ fo≥ thσ NZCPR/ZCPR▓á "WHEELó
  24. bytσ option, (SD-60.COM set up for ZCPR2 use with WHEEL at 3EH).
  25. SD-60 also has a "C" option to clear the screen. (Set up as ctrl
  26. Z in SD-60.COM.)
  27.  
  28.      The  basic operation of SD is as in previous releases.  You
  29. merely  type   "SD",   followed  by  an  optional  ambiguous  or
  30. unambiguous  filename (as  you  would  with  the  CCP  directory
  31. command).  Omitting  the  filename  (i.e.,  "SD  [CR]"), will be
  32. interpreted  as  "SD *.*".  Similarly, "SD A:" would  imply  "SD
  33. A:*.*" and "SD B:"  would  imply "SD B:*.*".  In addition to the
  34. filename option, up to 8 command  line options may be specified.
  35. If  options  are  to be specified, then  the  filename  must  be
  36. EXPLICITLY specified  by  at  least a drive code.  Option fields
  37. are  preceded  by a single dollar  sign  as  with  most  Digital
  38. Research programs  such as MAC, and may be essentially free-form
  39. in format.  Example:  SD  A:  $s  a  D  rn u0 fp.  Note that the
  40. reference  to the A drives in "A:" is mandatory.    Invoking  SD
  41. with a command  of the form "SD $s a D rn u0 fp" would result in
  42. SD thinking that  $S was the file to be searched for.  Note also
  43. that spaces and case  within  the option field are insignificant
  44. (i.e., "$ SADrNu0F p" is equivalent  to  "$  S A D R N U0 F P").
  45. The  only  exception concerns the "USER" option  which  will  be
  46. explained later.  Users should also be aware of two restrictions
  47. on the command  line  format.   SD scans the entire command line
  48. for a dollar sign preceded by at  least  1  blank to delimit the
  49. beginning  of  the option field.  For this reason,  invoking  SD
  50. with a command line  such as "SD $ $AR" is illegal since SD will
  51. consider the first dollar sign to be the option field delimiter.
  52. If you need to specify  a  a filename whose first character is a
  53. dollar sign, precede it with  a  drive  code as in "SD A:$ $AR".
  54. In  this  instance,  SD  will  consider  the first  dollar  sign
  55. insignifican⌠á a≤ i⌠ i≤ no⌠ precedeΣ b∙ ß blank«á (Notσ tha⌠á S─
  56. ècoulΣá als∩ bσ renameΣ t∩ DIR.CO═ o≥ somσ othe≥ name¼á iεá whicΦ
  57. casσ "SDó iε command≤ shoulΣ bσ replaceΣ witΦ DI╥ o≥ appropriatσ
  58. name.)
  59.  
  60.  
  61.  
  62.                                 1
  63. SD-60 Documentation Notes
  64.  
  65.  
  66.  
  67.  
  68.      The second restriction is that command  line options may be
  69. specified once and only once per invocation.   That  is,  "SD A:
  70. $SDS"  would be illegal since the "S" option is specified twice.
  71. This shortcoming  is  due  to  the fact that options can be made
  72. into defaults at assembly time. (Note that if an option is  made
  73. a default, (with a zero as option flag), it cannot be  specified
  74. without generating an error message.)
  75.  
  76.      The eleven options recognized are:  
  77.  
  78.   "S" - system option : system files will be included in
  79.         the output rather than being suppressed.  
  80.  
  81.   "F"  -  file  option : the directory  output  will  be
  82.         echoed to  a  disk  file  named  "SD.DIR" on the
  83.         DEFAULT drive.  If SD.DIR already  exists,  then
  84.         the directory output will be APPENDED to the end
  85.         of  the file.  Otherwise, SD.DIR will be created
  86.         as a new file.  The append feature allows you to
  87.         build  up  one massive file on the default drive
  88.         containing the directories of all of your disks,
  89.         without  having   to  concantenate  a  swarm  of
  90.         individual directory  files.  If you plan to use
  91.         this feature often,it will be simpler for you to
  92.         have a dedicated version  on  your  MASTCAT disk
  93.         with  AUTOR set TRUE.  The advantage  of this is
  94.         that  you  can  work  through  a  pile  of disks
  95.         without  having  to  CTRL-C  or  specify the "R"
  96.         option everytime you SD a new disk.   Failing to
  97.         do  this  will  result in the allocation  vector
  98.         being invalid, and FREE size will be wrong.  
  99.  
  100.   "U" - user option : allows  the  specification  of the
  101.         user  number for the directory of the form "Uxx"
  102.         where the  user  #  is  greater  than 0, but not
  103.         greater than a specified value not to exceed 15.
  104.         The user option specification will be illegal if
  105.         the user # is out of range, omitted,  or if U is
  106.         specified  on  a  pre-CP/M 2 system.  Note  that
  107.         since  the  user  option  requires  a  parameter
  108.         (i.e., the user number),  the  user  number must
  109.         immediately follow the "U" option on the command
  110.         field.    That is, "U1" is legal, but "U  1"  is
  111.         not.  In this respect, the U option differs from
  112. è        the other options  in  that  embedded spaces ARE
  113.         significant.  
  114.  
  115.   "A" - all users : causes SD to display  directories of
  116.         all  user  areas  starting  at  the  user   area
  117.         specified  in  the  U  option or, if U option is
  118.         omitted, the default user area and continuing up
  119.         to  MAXUSR  value  from  LODRV-HIDRV table.  (If
  120.     ZCPR2/WHLUSR=TRUE and WHEEL byte set, 0-MXZUSR.)
  121.  
  122.   "L" - .LBR list option :  allows for listing of ".LBR"
  123.         file  members.  ".LBR"  file  members  are shown
  124.         followed by number of sectors in file and an "s" 
  125.     to indicate file sizes are sectors and not "K".
  126.  
  127.  
  128.                                 2
  129. SD-60 Documentation Notes
  130.  
  131.  
  132.  
  133.  
  134.   "V" - If included, SD version number is displayed.
  135.  
  136.   "C" - If  included,  clear  screen   performed  before
  137.     directory information displayed.
  138.  
  139.   "N"  - no page option : unconditionally  disables  the
  140.         page  pause  option.   Useful when running SD in
  141.         the "F" and/or "A" modes when you don't want the
  142.         page prompt slowing you  down.   Note that SD-60
  143.         will  not  put  the page-pause prompt  into  the
  144.         output file or to printer if either enabled.
  145.  
  146.   "P" - printer option : forces all console output to be
  147.         echoed to the CP/M  list  device,  with the most
  148.         significant bit set to 0.  
  149.  
  150.   "D" - all disk option : allows SD to search  all  disk
  151.         drives  on-line  starting  with  the  disk drive
  152.         specified  or  implied  with  the  command  line
  153.         filename.    For example, "SD B: $D" will result
  154.         in SD searching  all drives beginning with drive
  155.         B.  "SD *.* $D" will  result in SD searching all
  156.         drives beginning with the  drive  that is logged
  157.         in.
  158.  
  159.   "R" - Reset disk system: a disk system reset  is  done
  160.     before directory information is accumulated.
  161.  
  162.      A≤áconfigured¼áSD-60.COM wil∞ automaticall∙ d∩ ß disδ rese⌠
  163. oε eacΦ use¼á anΣ thσ "P"¼á "Fó anΣ "Só option≤ arσ illega∞ wheε
  164. thσ ZCPR▓ WHEE╠ bytσ i≤ reset« (Use≥ area≤ restricteΣ wheε WHEE╠
  165. byte zero, all 0-15 user areas searched if WHEEL byte non-zero.)
  166.  
  167.      If   an  unrecognized  option  (or  illegal   user   option
  168. specification) is detected, then the command line will be played
  169. back to the  console  up  to  the  point  where  the  error  was
  170. detected.    However,  if the REPERR option is disabled, then SD
  171. èwill keep its mouth shut  and  ignore  everything on the command
  172. line  past the illegal field.  In this situation,  an  illegally
  173. specified  user  number  would  default back to the current user
  174. number.  The option of DISABLING  error  reporting  was included
  175. primarily  for systems with hidden doors and secret passageways.
  176. Shooting off  rockets  and  clanging  bells  everytime a holswap
  177. starts  "experimenting" just calls attention to  the  fact  that
  178. there really  IS  something  behind  that  hollow- sounding wall
  179. after all (if you get my drift).  
  180.  
  181.      As an added convenience, it is possible to "hard-wire" some
  182. or all of the command line options.  For example, if you want SD
  183. to ALWAYS perform a reset of the disk system  before putting its
  184. show  on the road, you can do just that.  For details,  see  the
  185. comments   preceding  the  option  field  lookup  table  in  the
  186. assembler source file.  
  187.  
  188.      Finally,  if  the  all-disk  and/or  all-user  options  are
  189. enabled,   it  may  be  desirable  to  restrict  searches.    To
  190.  
  191.  
  192.  
  193.                                 3
  194. SD-60 Documentation Notes
  195.  
  196.  
  197.  
  198.  
  199. facilitate this,  a  table is included in SD (beginning at label
  200. "LODRV" and continuing  through "HIDRV").  The table consists of
  201. a single byte for each drive  to  be  searched beginning with A.
  202. Each byte may be in the range of 0-15 mod  15  and  defines  the
  203. highest  user  number  that  SD  will search for that particular
  204. drive.  The highest drive number to  search  is  defined  by the
  205. length of the table.  If four DBs are present between LODRV  and
  206. HIDRV,  then  drives  A-D  can  be  searched.    The source file
  207. includes the LODRV-HIDRV table in its maximum configuration  for
  208. 16  drives.    However,  it  is  recommended that you delete DBs
  209. referencing  drives  that  aren't  available   on  your  system.
  210. Although  SD  will  intercept  attempts  to  search non-existant
  211. drives, there really isn't any point in allowing  SD  to  always
  212. search  drive  C  when  you  only  have  2  logical  drives; and
  213. depending  on  how  your  BIOS  is  constructed and how long  it
  214. monkeys around before advising the BDOS  of the select error, it
  215. could save some time. (Table set up for 2 drives, max user = 8.)
  216.  
  217.      
  218.                A THOUGHT FROM "THE LAST REVISOR"
  219.  
  220.      If you sit down and figure out the number  of  permutations
  221. of  options  and  equates  in the latest versions of SD,  you'll
  222. understand why there aren't  any warranties as to the absence of
  223. entomological cybernoids.  I leave  it  to the CP/M community to
  224. smoke  out  what bugs may pop-up when a certain  combination  of
  225. èvariables occurs.    If  you  find  any  bugs,  please  leave an
  226. advisory or a fix on either TCBBS or the Hyde Park RCP/M so that
  227. they can be exterminated.  
  228.  
  229.      Note  that you don't  really have  to be running  NZCPR  or
  230. ZCPR2 to use the wheel byte feature, just get the WHEEL  program
  231. and add code to BYE to make sure  WHEEL byte  is cleared  when a
  232. remote user logs on, (before entering CP/M).  The way SD is  set
  233. up as released, it can be used in remote access mode or in local
  234. mode.
  235.  
  236.      This documentation was updated for  SD version 6.0  by  Kim
  237. Levitt,  (sysop  of  Hollywood  RCPM/RBBS  (213)  653-6398),  on
  238. 08/27/83, and released as SD-60.DOC (SD-60.DQC) in SD-60.LBR.
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.                                 4
  260. SD-60 Documentation Notes
  261.  
  262.