home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / mbug / mbug044.arc / FIXDIR.DOC < prev    next >
Text File  |  1979-12-31  |  4KB  |  135 lines
  1.  
  2.  
  3.                   DOCUMENTATION FOR FIXDIR.COM
  4.  
  5. Introduction
  6. ------------
  7.  
  8.      FIXDIR  is  program to allow renaming or erasing of  illegal 
  9. filenames from CP/M directories.
  10.  
  11. Usage
  12. -----
  13.  
  14.      FIXDIR [d:]
  15.  
  16. Where
  17.  
  18.      [d:]           is an optional drive identifier or ?
  19.  
  20. Examples
  21. --------
  22.  
  23.      FIXDIR
  24.  
  25.           This  will check the directory of the currently  logged 
  26.           drive.
  27.  
  28.      FIXDIR B:
  29.  
  30.           This will check the directory of drive B:.
  31.  
  32.      FIXDIR ?
  33.  
  34.           This  will display a short "usage" message and  return 
  35.           to CP/M without doing any directory checking.
  36.  
  37. Error Messages
  38. --------------
  39.  
  40.      If more than one argument is given on the command line,  the 
  41. command  line error is displayed and the "usage" message is  dis
  42. played.
  43.  
  44. A>FIXDIR A: B:
  45.     FIXDIR version 0.95 (Preliminary evaluation release)
  46.     (C) 1981, Software Tools - Sydney, Australia.
  47.     Corrects illegal file names in a CP/M disk directory.
  48.  
  49. Command line error : B:
  50.  
  51. USAGE :
  52.     FIXDIR
  53.     FIXDIR B:
  54.  
  55.     Exiting to CP/M
  56.  
  57. Internal Prompts
  58. ----------------
  59.  
  60.      If  an illegal filename is located in the directory the user 
  61. is  prompted to erase or rename the file.  If rename is chosen  a 
  62. new  filename is prompted.  The entered filename is also  checked 
  63. for legality:-
  64.  
  65.     Illegal CP/M file name : bad     .fil
  66.  
  67.         Press 'E' to erase  file:  
  68.         Or
  69.     Press 'R' to rename file : 
  70.  
  71.     Enter new file name : goo,d.one
  72.  
  73.     BAD FILENAME entered as new name !
  74.  
  75.     Enter new file name :good.one
  76.  
  77.     RENAMING bad     .fil to GOOD    .ONE
  78.     
  79. Performing another pass.
  80.  
  81.  
  82.     No illegal file names in directory on this pass.
  83.  
  84.     There were 2 passes performed.
  85.  
  86.  
  87.  
  88. Tutorial on FIXDIR
  89. ------------------
  90.  
  91.      There  are  certain  characters which are  illegal  in  CP/M 
  92. filenames  as  far as a CP/M disk directory is  concerned.  These 
  93. are:
  94.  
  95.         <>.,;:=?*[] and all lower case alphabetical characters
  96.  
  97.      Note  that  some  of the characters are legal in  CP/M  file 
  98. specifiers which may be given to utility programs or used in BDOS 
  99. calls but the should NEVER appear in a directory display. 
  100.  
  101.      Also note that the Digital Research documentation  specified 
  102. the  comma "," as illegal but that the CCP will accept  filenames 
  103. with  embedded commas.  FIXDIR follows the printed  specification 
  104. and considers commas illegal in directory enteries.
  105.  
  106.      In  general  the CCP (console command  processor)  will  not 
  107. accept  illegal file names so it is not possible to put them into 
  108. to the directory with the "SAVE" command.  There is no protection 
  109. built  into the BDOS to stop illegal filenames being  created  in 
  110. the  disk  directory  as a result of BDOS file create  or  rename 
  111. commands. The most common way that illegal filenames get into the 
  112. disk directory is as a result of a save operation from  Microsoft 
  113. BASIC.  If  the  filename is typed in lower case characters  from 
  114. within  Microsoft  BASIC  it  will  be  saved  that  way  in  the 
  115. directory.  The  next  most common way is as a result of  a  high 
  116. level language program going wild and creating spurious files.
  117.  
  118.      Directory  enteries which contain illegal file names  cannot 
  119. be  erased with ERA command as they will never be matched by  the 
  120. CCP  (Except if you specify *.*).  The CCP converts  all  command 
  121. lines  to  UPPER  CASE before processing them,  so  even  if  you 
  122. specify  a lower case file name it will be upper case by the time 
  123. the BDOS tries to match the filename with a directory entry.
  124.  
  125.      FIXDIR  is written in the "C" language and directly  examins 
  126. directory  enteries  without relying on the BDOS individual  file 
  127. name  matching  function.  The illegal name finding  function  is 
  128. renterent  and is called repeatedly until no more  illegal  file
  129. names  can  be located.  The total number of passes  through  the 
  130. renterent  function is reported at the end of the program if  any 
  131. illegal file names were found.
  132.  
  133. END OF FIXDIR.DOC
  134.  
  135.