home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / simtel / sigm / vols000 / vol096 / xdir-a86.doc < prev    next >
Text File  |  1984-04-29  |  6KB  |  119 lines
  1.  
  2.                     The XDIR Directory Program
  3.  
  4.      XDIR  (Extended Directory Display) is an enhanced version of 
  5. the  Digital Research 'built-in' CP/M command 'DIR' which  allows 
  6. the  userto  search  a range of drives and/or user  areas  for  a 
  7. specified   file,  and creat a sorted  directory  display.   This 
  8. capability is patterned after FILEFIND, but is significantly more 
  9. useful in that  XDIR will report the sizes of files matched.    A  
  10. new  BDOS intercept  routine  has been added, which although more 
  11. involved   than   the  FILEFIND  method,    is   more   generally  
  12. applicable  and should  run "as-is" on most CP/M systems.   Thus, 
  13. by using XDIR,  the use of a separate FILEFIND program should  be 
  14. unnecessary.  
  15.  
  16.                     XDIR - Basic User Operation
  17.  
  18.      You  merely   type   "XDIR",    followed  by   an   optional  
  19. ambiguous   or  unambiguous  filename (as  you  would  with   the  
  20. CCP  directory command).   Omitting  the  filename  (i.e.,  "XDIR  
  21. [CR]"),  will be interpreted  as  "XDIR *.*".   Similarly,  "XDIR 
  22. A:" would  imply  "XDIR A:*.*" and "XDIR B:"  would  imply  "XDIR 
  23. B:*.*".   In  addition  to the filename option,  up to 8  command  
  24. line  options  may  be  specified.    If   options   are   to  be 
  25. specified, then  the  filename  must  be EXPLICITLY specified  by  
  26. at  least a drive code.  Option fields are  preceded  by a single 
  27. dollar  sign  as  with  most  Digital Research programs  such  as 
  28. MAC,  and may be essentially free-form in format.  Example:  XDIR  
  29. A:  $s  a  D  rn u0 fp.  Note that the reference  to the A drives 
  30. in  "A:" is mandatory.     Invoking  XDIR with a command  of  the 
  31. form  "XDIR  $s a D rn u0 fp" would result in XDIR thinking  that  
  32. $S  was the file to be searched for.   Note also that spaces  and 
  33. case   within   the  option field  are  insignificant  (i.e.,  "$ 
  34. SADrNu0F p" is equivalent  to  "$  S A D R N U0 F P").  The  only  
  35. exception  concerns the "USER" option  which  will  be  explained 
  36. later.   Users  should also be aware of two restrictions  on  the 
  37. command  line  format.   XDIR scans the entire command line for a 
  38. dollar  sign  preceded  by  at  least  1  blank  to  delimit  the 
  39. beginning   of  the option field.   For  this  reason,   invoking  
  40. XDIR  with a command line  such as "XDIR $ $AR" is illegal  since 
  41. XDIR  will consider the first dollar sign to be the option  field 
  42. delimiter.   If  you  need to specify  a  a filename whose  first 
  43. character is a dollar sign, precede it with  a  drive  code as in 
  44. "XDIR A:$ $AR".   In  this  instance,   XDIR  will  consider  the 
  45. first   dollar   sign insignificant as it is not  preceded  by  a 
  46. blank.  
  47.  
  48.  
  49.      The  second restriction is that command  line options may be 
  50. specified once and only once per invocation.    That  is,   "XDIR 
  51. A:  $XDIRS"   would be illegal since the "S" option is  specified 
  52. twice.   This shortcoming  is  due  to  the fact that options can 
  53. be made into defaults at assembly time.  
  54.  
  55.      The eight options recognized are:  
  56.  
  57.   "S"  - system  option :  system files will be included  in  the 
  58.          output rather than being suppressed.  
  59.  
  60.   "F"  -  file  option :  the directory  output  will  be  echoed 
  61.          to   a   disk  file  named  "XDIR.DIR"  on  the  DEFAULT 
  62.          drive.  If XDIR.DIR already  exists,  then the directory 
  63.          output  will  be  APPENDED  to the  end  of   the  file.  
  64.          Otherwise,  XDIR.DIR will be created as a new file.  The 
  65.          append feature allows you to build  up  one massive file 
  66.          on  the default drive containing the directories of  all 
  67.          of  your  disks,  without  having   to  concantenate   a  
  68.          swarm  of individual directory  files.
  69.  
  70.   "U"  - user option :  allows  the  specification  of  the  user  
  71.          number  for  the directory of the form "Uxx"  where  the  
  72.          user   #   is  greater  than 0,  but not greater than  a 
  73.          specified  value  not to exceed  15.   The  user  option 
  74.          specification  will  be illegal if the user # is out  of 
  75.          range,  or omitted.  Note  that since  the  user  option  
  76.          requires   a  parameter (i.e.,  the user  number),   the  
  77.          user   number must immediately follow the "U" option  on 
  78.          the command field.    That is, "U1" is legal, but "U  1"  
  79.          is not.   In this respect, the U option differs from the 
  80.          other   options    in    that    embedded   spaces   ARE 
  81.          significant.  
  82.  
  83.   "A"  - all users :  causes XDIR to display  directories of  all  
  84.          user   areas   starting  at  the  user   area  specified  
  85.          in   the   U  option or,  if U option  is  omitted,  the 
  86.          default  user  area  and continuing up  to  the  maximum 
  87.          number of user directories (15).  
  88.  
  89.   "R" - reset option : allows for automatic resetting of the disk 
  90.          prior  to  performing  directory  search  so  that   the  
  91.          allocation vector  will  be  updated.   Same as doing  a 
  92.          CTRL-C  when  changing disks,  but handy if  you  didn't  
  93.          (such  as  when  running  a SUBMIT  file).   Useful  for 
  94.          XDIRing a stack of disks with the "F" option, but  slows  
  95.          down XDIR considerably in normal use.  
  96.  
  97.   "N"  - no  page option :  unconditionally  disables   the  page  
  98.          pause   option.    Useful  when running XDIR in the  "F" 
  99.          and/or  "A"  modes when you don't want the  page  prompt 
  100.          slowing you  down.    Note that XDIR will  not  put  the 
  101.          page-pause prompt  into  the output file.  
  102.  
  103.   "P" -  printer option : forces all console output to be  echoed 
  104.          to  the CP/M  list  device,   with the most  significant 
  105.          bit set to 0.  
  106.  
  107.   "D" - all disk option : allows XDIR to search  all  disk drives  
  108.          on-line   starting  with  the  disk drive specified   or  
  109.          implied   with   the   command   line  filename.     For 
  110.          example, "XDIR B: $D" will result in XDIR searching  all 
  111.          drives  beginning  with  drive B.   "XDIR *.*  $D"  will  
  112.          result  in XDIR searching all drives beginning with  the  
  113.          drive  that is logged in.  
  114.  
  115.      If   an  unrecognized  option  (or  illegal   user    option 
  116. specification) is detected,  then the command line will be played 
  117. back  to the  console  up  to  the  point  where  the  error  was 
  118. detected.
  119.