home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpm / utils / filcpy / csweep.lbr / CSWEEP.DQC / CSWEEP.DOC
Encoding:
Text File  |  1986-04-07  |  4.8 KB  |  119 lines

  1. CSWEEP  --   A command-line file management program:
  2. ====================================================
  3.  
  4.  
  5. Lindsay Haisley
  6. 2406 B Winstead La.
  7. Austin, TX  78703
  8.  
  9.  
  10. DESCRIPTION:
  11. ============
  12.  
  13. CSWEEP is a file copy program similar in function to the popular SWEEP and 
  14. NEWSWEEP programs.  Unlike these programs, CSWEEP operates entirely from 
  15. command line options and has no interactive mode.  In this respect it is 
  16. similar to Digital Research's PIP program.  CSWEEP however, offers the 
  17. following options not available with PIP.
  18.  
  19. **  Multiple copies on different drive/user areas with a single operation.
  20.  
  21. **  ZCPR3 style drive/user access.  Source and destination files may be on 
  22.     any drive (A thru P) or user area (0 thru 31).
  23.  
  24. **  Source file may be deleted after copying (-d option)
  25.  
  26. **  True CRC file copy checking (-v option)
  27.  
  28. CSWEEP is extremely useful for copying or moving files with any program or 
  29. operating system that uses command files, such as SUBMIT.  It will also 
  30. save many keystrokes over SWEEP or NEWSWEEP when moving large numbers of 
  31. files around in your disk system. 
  32.  
  33.  
  34. USAGE:
  35. ======
  36.  
  37. The command line format for CSWEEP is:
  38.  
  39.         CSWEEP f1 [f2 .. fn] sdu: ddu1: [ddu2: ... ddu6:] [-v] [-d]
  40.  
  41. Optional command arguments are in square brackets.  The arguments are:
  42.  
  43.     f1 .. fn        --  file names to copy (may be ambiguous)
  44.     sdu:            --  source disk/user (e.g. a0:)
  45.     ddu1: .. ddu6:  --  destination disk/user 
  46.     -v              --  verify copies (CRC)
  47.     -d              --  delete source copies
  48.  
  49. All drive/user designations are in the form of a drive letter followed by 
  50. an OPTIONAL user area number followed by a colon, as in the example above.
  51. Any other format will be flagged as an error.  The current user area is 
  52. assumed if none is given.
  53.  
  54. Filenames, drive/user specs and options may be given in any order with the 
  55. exception that the first valid drive/user spec encountered will be 
  56. interpreted by CSWEEP as the source d/u for copying.
  57.  
  58.  
  59. AMBIGUOUS FILE NAMES: 
  60. ===================== 
  61.  
  62. CSWEEP accepts ambiguous file names of the standard CP/M sort with one 
  63. addition.  An ambiguous file name (afn) preceded by a "!" causes all names 
  64. matching the given afn to be EXCLUDED from the resulting copy. Thus, to 
  65. copy all files except "COM" files from a: to b:, say:
  66.  
  67.                    CSWEEP *.* !*.com a: b:
  68.  
  69. When giving a "!" afn, "*" chars in the string match to the end of either 
  70. the filename or extension, just like CP/M, but "?" chars match ONE and 
  71. ONLY ONE character in either the filename or extension.
  72.  
  73.  
  74. OPTIONS:
  75. ========
  76.  
  77. CSWEEP accepts two command options which must be preceded by a "-" sign.
  78.  
  79. -D  Delete the source file after all copies have been made.  If a write 
  80.     error of any sort occurs during a file copy, the source file will NOT 
  81.     be deleted.
  82.  
  83. -V  Verify each copy with a CRC (Cyclic Redundancy) check.  This option 
  84.     will slow down the operation of CSWEEP considerably since each copy 
  85.     file must be read back and verified against the CRC of the source.
  86.  
  87.  
  88. OPERATION:
  89. ==========
  90.  
  91. CSWEEP will copy all files as instructed unless a BDOS file error is 
  92. encountered in the copy process.  If an error occurs in creating or 
  93. writing to a copy file, CSWEEP will report the error, delete the partial 
  94. copy (if any) and drop the disk/user in which the error occurred from 
  95. further copy operations.  After completing it's work, CSWEEP will report a 
  96. tally of files copied and errors encountered.
  97.  
  98. If your CP/M system memory is exceptionally small (less than 48K) you may 
  99. receive an "Out of Memory" error when you attempt to run CSWEEP.  If your 
  100. operating system is of the type which takes proprietary control of 
  101. portions of high memory (such as ZCPR3) CSWEEP may crash or simply lock 
  102. up.  If this happens, you may use any convenient debugger or disk utility 
  103. to change the byte at address 16B8 hex (157D hex if referenced to 0 rather 
  104. than 100 hex).  This byte follows the word "MEMORY" in memory and 
  105. determines the number of 128 byte sectors read into memory at one time.  A 
  106. small value here will assure the safety of your operating system, but will 
  107. cause the program to run quite slowly.  The default in the program as 
  108. distributed is 180 sectors, or about 22K.  Thus CSWEEP requires a total of 
  109. c.a. 38K bytes to operate.  This should not present a problem to most 
  110. operating systems.
  111.  
  112.  
  113.            * * * * * * * * * * * * * * * * * * * * * *
  114.  
  115.  
  116. Many thanks and much credit to Leor Zolman of BDS Software for the C 
  117. routines which make up the main body of the code for CSWEEP, and also for 
  118. the documentation for the wildexp function which is paraphrased in the 
  119. "Ambiguous File Names" section above.