home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpm / utils / filcpy / csweep21.lbr / CSWEEP2.DQC / CSWEEP2.DOC
Encoding:
Text File  |  1986-10-01  |  5.8 KB  |  147 lines
  1. CSWEEP  --   A command-line file management program:
  2. Documentation for Version 2.1
  3. ====================================================
  4.  
  5.  
  6. Lindsay Haisley
  7. 14206 Spreading Oaks
  8. Leander, TX  78641
  9.  
  10.  
  11. DESCRIPTION:
  12. ============
  13.  
  14. CSWEEP is a file copy program similar in function to the popular SWEEP and 
  15. NEWSWEEP programs.  Unlike these programs, CSWEEP operates entirely from 
  16. command line options and has no interactive mode.  In this respect it is 
  17. similar to Digital Research's PIP program.  CSWEEP however, offers the 
  18. following options not available with PIP.
  19.  
  20. **  Multiple copies on different drive/user areas with a single operation.
  21.  
  22. **  ZCPR3 style drive/user access.  Source and destination files may be on 
  23.     any drive (A thru P) or user area (0 thru 31).
  24.  
  25. **  Source file may be deleted after copying (-d option)
  26.  
  27. **  True CRC file copy checking (-v option)
  28.  
  29. **  Version 2 provides a pre-copy file size and disk freespace check.
  30.     
  31. CSWEEP is extremely useful for copying or moving files with any program or 
  32. operating system that uses command files, such as SUBMIT.  It will also 
  33. save many keystrokes over SWEEP or NEWSWEEP when moving large numbers of 
  34. files around in your disk system.  CSWEEP is as fast or faster than these 
  35. programs for all types of file copy operations.
  36.  
  37.  
  38. USAGE:
  39. ======
  40.  
  41. The command line format for CSWEEP2 is:
  42.  
  43. CSWEEP f1 [f2 .. fn] sdu: ddu1: [ddu2: ... ddu6:] [options]                                                                                           
  44.  
  45.  
  46. Optional command arguments are in square brackets.  The arguments are:
  47.  
  48.                                          
  49. f(x)     --  Ambiguous file names       
  50. sdu:     --  Source disk/user or * for current (e.g. a0:)   
  51. ddu(x):  --  Dest. disk/user or * for current
  52.                                                                                    
  53. Options:   
  54. -v      Verify (CRC)    
  55. -d      Delete source copies   
  56. -r      Report stats   
  57. -s      Report and copy
  58.  
  59.                                                                                     
  60. All drive/user designations are in the form of a drive letter followed by 
  61. an OPTIONAL user area number followed by a colon, as in the example above. 
  62. Any other format will be flagged as an error.  The current user area is 
  63. assumed if none is given.
  64.  
  65. Note that Vs. 2 will allow the use of the "*" for any d/u spec to designate 
  66. the current disk drive and user area.
  67.  
  68. Filenames, drive/user specs and options may be given in any order with the 
  69. exception that the first valid drive/user spec encountered will be 
  70. interpreted by CSWEEP as the source d/u for copying.
  71.  
  72.  
  73. AMBIGUOUS FILE NAMES: 
  74. ===================== 
  75.  
  76. CSWEEP accepts ambiguous file names of the standard CP/M sort with one 
  77. addition.  An ambiguous file name (afn) preceded by a "!" causes all names 
  78. matching the given afn to be EXCLUDED from the resulting copy. Thus, to 
  79. copy all files except "COM" files from a: to b:, say:
  80.  
  81.                    CSWEEP *.* !*.com a: b:
  82.  
  83. When giving a "!" afn, "*" chars in the string match to the end of either 
  84. the filename or extension, just like CP/M, but "?" chars match ONE and 
  85. ONLY ONE character in either the filename or extension.
  86.  
  87.  
  88. OPTIONS:
  89. ========
  90.  
  91. CSWEEP accepts four command options which must be preceded by a "-" sign.
  92.  
  93. -D  Delete the source file after all copies have been made.  If a write 
  94.     error of any sort occurs during a file copy, the source file will NOT 
  95.     be deleted.
  96.  
  97. -V  Verify each copy with a CRC (Cyclic Redundancy) check.  This option 
  98.     will slow down the operation of CSWEEP considerably since each copy 
  99.     file must be read back and verified against the CRC of the source.
  100.  
  101. -R  For each disk to receive copies, summarize the available space and 
  102.     determine the total size of files to be assigned to that disk.  For 
  103.     each disk, the block size, free space, total of files assigned and 
  104.     remaining freespace (after copying) are given.  Note that if target 
  105.     disks have different block sizes then the total size of assigned files 
  106.     will vary accordingly.  This option will give only the size report.  No 
  107.     copying will be done.
  108.     
  109. -S  Same as the -R option except that copying will be done automatically 
  110.     following the report unless a disk with insufficient space to receive 
  111.     copies is found, in which case an option to abort the copy is offered.
  112.     
  113. Note that if any of the files to be copied already exist on a target disk 
  114. then the space report for that disk will be in error.  New files will 
  115. simply overwrite old files of the same name.
  116.  
  117.  
  118.  
  119. OPERATION:
  120. ==========
  121.  
  122. CSWEEP will copy all files as instructed unless a BDOS file error is 
  123. encountered in the copy process.  If an error occurs in creating or 
  124. writing to a copy file, CSWEEP will report the error, delete the partial 
  125. copy (if any) and drop the disk/user in which the error occurred from 
  126. further copy operations.  After completing it's work, CSWEEP will report a 
  127. tally of files copied and errors encountered.
  128.  
  129. Version 2 now allocates memory space dynamically at run time so that it is 
  130. not necessary to set the memory size in the object code as with version 1.1.
  131.  
  132. A serious bug in Vs. 1.1 is fixed in Vs. 2.0.  Previously, if the -v option 
  133. was given on a copy operation to several disks, all copies after the first 
  134. would be incomplete.  This no longer is the case.
  135.  
  136.  
  137.            * * * * * * * * * * * * * * * * * * * * * *
  138.  
  139.  
  140. Many thanks and much credit to Leor Zolman of BDS Software for the C 
  141. routines which make up the main body of the code for CSWEEP, and also for 
  142. the documentation for the wildexp function which is paraphrased in the 
  143. "Ambiguous File Names" section above.
  144.  
  145. Copies of the source code for CSWEEP are available from the author for a 
  146. nominal fee.
  147.