home *** CD-ROM | disk | FTP | other *** search
/ Lion Share / lionsharecd.iso / utils_mz / xrm21.zip / XRM2.DOC < prev   
Text File  |  1992-06-30  |  5KB  |  130 lines
  1. Xremove 2.0
  2. written by Edmond Leung 
  3. 12/03/91
  4. CompuServe UID 70143,2217
  5.  
  6. Xremove 2.0 is a combination of pervious version of Xdel 1.3 and Xremove 1.1
  7. With the new command line options. You can choose to search of multipule files
  8. or directories for deletion, display directories tree, remove empty
  9. directories, search files by attribute.
  10.  
  11. You are free to make copies of Xremove under two conditions.
  12. 1) Main program and this documentation file are together.
  13. 2) No modification have been made to both files.
  14.  
  15. Usage: XRM <-f|-d>[options...] [drive][path]<sub-directory|filespec>
  16.  
  17. command  -d     search and remove sub-directories.
  18.      -f     search for files
  19.  
  20. options  a      include All type of files
  21.      s      include System files
  22.      h      include Hidden files
  23.      r      include Read-only files
  24.      e      remove Empty directories, default is on only when used with
  25.         command -d
  26.      x      eXclude sub-directories search, Xremove will search through
  27.         all lower sub-directories by default
  28.      t      display directories Tree
  29.      u      Unconditional delete. No confirmation before Xremove delete
  30.         files or sub-directories.
  31.      p      Pause between directory tree pages
  32.      q      Quiet mode (no messages, except prompts)
  33.  
  34.      No space should be added between options and command switch.
  35.      command prefix must be character '-'
  36.  
  37.  
  38. File attribute
  39. --------------
  40. Without a,s,h,r options, only normal files will be included. When applying 
  41. s,h,r options, normal files will always included plus files with the same
  42. attribute on. Use option 'a' will search all type of files.
  43.  
  44. Remove empty sub-directories
  45. ----------------------------
  46. When using command -f with the 'e' options, empty directory will be removed
  47. during deletion. This option is on by default when use command -d to remove
  48. directories.
  49.  
  50. Exclude sub-directories search 
  51. ------------------------------
  52. Xremove will search through sub-directories by default. When 'x' is added
  53. with command -f, only current directory will be searched. With command -d,
  54. no lower sub-directories will be removed, only all files in current directory 
  55. will be deleted. Neither directories tree nor directories report will be 
  56. displayed when eXclude sub-directories option is on.
  57.  
  58. Display directories tree
  59. ------------------------
  60. 't' option will take effect only when used with command -d. With this option,
  61. Xremove will display a directories tree from current directory or from given
  62. drive and path. An '*' appear after the sub-directory name indicate it
  63. is an empty sub-directory. Press any key to pause and continue the display.
  64.  
  65.  
  66. Unconditional delete
  67. --------------------
  68. Xremove will not stop and ask you to confirm the deletion of files or removal 
  69. of empty directories when 'u' is added. But error messages or summary will
  70. still display when Xremove terminated. For calling Xremove from a batch file,
  71. use with 'q'uiet option. Four different errorlevel will be set when Xremove 
  72. terminate. Only use this option when you know exactly what files and 
  73. directories will be deleted!
  74.  
  75. Page pause
  76. ----------
  77. When 'p' option is used. Screen will pause when directory tree is longer than
  78. one screen page. Press 's' to disable the page pause or any other key will
  79. pause again when another screen. Without this option, you can still pause and
  80. continue the screen by hitting any key.
  81.  
  82. Quiet mode
  83. ----------
  84. When 'q' is applied. No summary or messages will be displayed. Only
  85. confirmation prompts will display when 'u' option is not used. Combination
  86. of 'u' and 'q' options will not display any message all through the process.
  87.  
  88. Summary
  89. -------
  90. Xremove will display a summary of the number of sub-directory, file found and
  91. deleted when the program terminate or you quit at the middle of the operation.
  92. When eXclude sub-directories is on, no summary of directory will reported.
  93.  
  94.  
  95. Errorlevel
  96. ----------
  97.  
  98.     0       files or directories found and deleted.
  99.     1       bad command or options, file not found, no files or
  100.         directories have been deleted.
  101.     3       matching filename were found, but file attribute does not
  102.         match. Matching filename with normal and/or with archive flag
  103.         on, or files with same attribute were deleted.
  104.     5       User abort operation when Xremove ask for confirmation on
  105.         delete files or remove sub-directories.
  106.  
  107.  
  108. Registration
  109. ------------
  110. If you find Xremove 2.0 helpful, easy to use, a registration of US$10
  111. will be appreciated. And you will receive future version automatically.
  112. Please state the version of the software that you currently have. 
  113. Send money order to address:         
  114.                 Edmond Leung
  115.                 2434 Echo Park Ave
  116.                 Los Angeles, CA 90026
  117.                 USA
  118.  
  119. Credits
  120. -------
  121. Special thanks to Johnny Chu, my good friend who gave me comments on Xremove.
  122. Download every updated beta version of Xremove, take the risk of data loss
  123. to beta test Xremove. This will never worked out without his patience.
  124. Thanks Johnny.
  125.  
  126.  
  127. Thanks for your support and more 'X' series utilities are coming soon to
  128. make your DOS computing life easier.
  129.  
  130.