home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / znode3 / util / csweep3.lbr / CSWEEP3.DZC / CSWEEP3.DOC
Encoding:
Text File  |  1993-06-09  |  6.0 KB  |  154 lines
  1. CSWEEP  --   A command-line file management program:
  2. Documentation for Version 3.0
  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 to and from different drive/user areas with a single 
  21.     operation
  22.  
  23. **  ZCPR3 style drive/user access.  Source and destination files may be on 
  24.     any drive (A thru P) or user area (0 thru 31)
  25.  
  26. **  Source files may be deleted after copying (-d option)
  27.  
  28. **  True CRC file copy checking (-v option)
  29.  
  30. **  Archiving supported for making disk backups
  31.  
  32. **  Pre-copy file size and disk freespace check
  33.     
  34. CSWEEP is extremely useful for copying or moving files with any program or 
  35. operating system that uses command files, such as SUBMIT.  It will also 
  36. save many keystrokes over SWEEP or NEWSWEEP when moving large numbers of 
  37. files around in your disk system.  CSWEEP is as fast or faster than these 
  38. programs for all types of file copy operations.
  39.  
  40.  
  41. USAGE:
  42. ======
  43.  
  44. The command line format for CSWEEP2 is:
  45.  
  46. CSWEEP du:f1 [du:f2 .. du:fn] ddu1: [ddu2: ... ddu6:] [options]                                                                                           
  47.  
  48.  
  49. Optional command arguments are in square brackets.  The arguments are:
  50.  
  51.                                          
  52. f1, f2, etc.        --  Ambiguous file names (! prefix excludes)      
  53. ddu1:, ddu2, etc.    --  Destination disk/user or * for current
  54.                                                                                    
  55. Options:   
  56. -v    Verify (CRC)    
  57. -d    Delete source copies   
  58. -q    Report stats only   
  59. -r    Report stats and copy
  60. -a    Copy non-archived files and archive source after copying
  61. -s    Exclude system files from copy
  62.  
  63.                                                                                     
  64. All drive/user designations are in the form of a drive letter followed by a 
  65. user area number followed by a colon, as in the example above.  If either 
  66. spec is ommitted, the current drive or user is assumed.   Any other format 
  67. will be flagged as an error.
  68.  
  69. The use of the "*" for any destination du: spec designates the current disk 
  70. drive and user area.
  71.  
  72. Filenames, drive/user specs and options may be given in any order.
  73.  
  74.  
  75. AMBIGUOUS FILE NAMES: 
  76. ===================== 
  77.  
  78. CSWEEP accepts ambiguous file names of the standard CP/M sort with one 
  79. addition.  An ambiguous file name (afn) preceded by a "!" causes all names 
  80. matching the given afn to be EXCLUDED from the resulting copy. Thus, to 
  81. copy all files except *.COM files from the current du: to b: and c0:, say:
  82.  
  83.                    CSWEEP *.* !*.com  b: c0:
  84.  
  85. When giving a "!" afn, "*" chars in the string match to the end of either 
  86. the filename or extension, just like CP/M, but "?" chars match ONE and 
  87. ONLY ONE character in either the filename or extension.
  88.  
  89.  
  90. OPTIONS:
  91. ========
  92.  
  93. CSWEEP Vs. 3 accepts 6 command options which must be preceded by a "-" sign.
  94.  
  95. -D  Delete the source file after all copies have been made.  If a write 
  96.     error of any sort occurs during a file copy, the source file will NOT 
  97.     be deleted.
  98.  
  99. -V  Verify each copy with a CRC (Cyclic Redundancy) check.  This option 
  100.     will slow down the operation of CSWEEP considerably since each copy 
  101.     file must be read back and verified against the CRC of the source.
  102.  
  103. -Q  For each disk to receive copies, summarize the available space and 
  104.     determine the total size of files to be assigned to that disk.  For 
  105.     each disk, the block size, free space, total of files assigned and 
  106.     remaining freespace (after copying) are given.  Note that if target 
  107.     disks have different block sizes then the total size of assigned files 
  108.     will vary accordingly.  This option will give only the size report.  No 
  109.     copying will be done.
  110.     
  111. -R  Same as the -R option except that copying will be done automatically 
  112.     following the report unless a disk with insufficient space to receive 
  113.     copies is found, in which case an option to abort the copy is offered.
  114.     
  115. -S  All files with a system attribute will be excluded from the copy 
  116.     process.  
  117.  
  118. -A  All files with an archive attribute (high bit of the third filename 
  119.     extension character set) will be excluded automatically from the copy 
  120.     process.  After copying, the archive bit of the source file is set.  
  121.     Systems which support file archiving will reset the archive bit on any 
  122.     file which has been written to.  This is extremely useful for making 
  123.     backups of hard disk files.
  124.  
  125. Note that if any of the files to be copied already exist on a target disk 
  126. then the space report for that disk will be in error.  New files will 
  127. simply overwrite old files of the same name.
  128.  
  129.  
  130.  
  131. OPERATION:
  132. ==========
  133.  
  134. CSWEEP will copy all files as instructed unless a BDOS file error is 
  135. encountered in the copy process.  If an error occurs in creating or 
  136. writing to a copy file, CSWEEP will report the error, delete the partial 
  137. copy (if any) and drop the disk/user in which the error occurred from 
  138. further copy operations.  After completing it's work, CSWEEP will report a 
  139. tally of files copied and errors encountered.
  140.  
  141.  
  142.            * * * * * * * * * * * * * * * * * * * * * *
  143.  
  144.  
  145. Many thanks and much credit to Leor Zolman of BDS Software for the C 
  146. routines which make up the main body of the code for CSWEEP, and also for 
  147. the documentation for the wildexp function which is paraphrased in the 
  148. "Ambiguous File Names" section above.
  149.  
  150. Copies of the source code for CSWEEP3 are available from the author for a 
  151. nominal fee.
  152.  
  153.                                    
  154.