home *** CD-ROM | disk | FTP | other *** search
/ Frostbyte's 1980s DOS Shareware Collection / floppyshareware.zip / floppyshareware / USCX / FILEUT-2.ZIP / ARC.DOC next >
Text File  |  1985-05-06  |  11KB  |  321 lines

  1.                                   ARC
  2.  
  3.                          File Archive Utility
  4.  
  5.  
  6. (C) COPYRIGHT 1985 by System Enhancement Associates; ALL RIGHTS RESERVED
  7.  
  8.  
  9. This file describes the ARC file utility, version 3.04, which was 
  10. created by System Enhancement Associates on 17 April 1985.
  11.  
  12. ARC is the copyrighted property of System Enhancement Associates.  You 
  13. are granted a limited license to use ARC, and to copy it and 
  14. distribute it, provided that the following conditions are met:
  15.  
  16. 1)  No fee may be charged for such copying and distribution.
  17.  
  18. 2)  ARC must be distributed as a complete set of all files.
  19.  
  20. 3)  ARC may ONLY be distributed in its original, unmodified state.
  21.  
  22. Any voluntary contributions for the use of this program will be 
  23. appreciated, and should be sent to:
  24.  
  25.     System Enhancement Associates
  26.     12 Franklin Avenue
  27.     Clifton, NJ  07011
  28.  
  29.  
  30.  
  31.  
  32. ARC is used to create and maintain file archives.  An archive is a 
  33. group of files collected together into one file in such a way that the 
  34. individual files may be recovered intact.
  35.  
  36. ARC is different from other archive and library utilities in that it 
  37. automatically compresses the files being archived, so that the 
  38. resulting archive takes up a minimum amount of space.  
  39.  
  40. When ARC is used to add a file to an archive it analyzes the file to 
  41. determine which of three packing methods will result in the greatest 
  42. savings.  These three methods are:
  43.  
  44. 1)  No compression; the file is stored intact.
  45.  
  46. 2)  Repeated-character compression; repeated sequences of the same 
  47.     byte value are collapsed into a three-byte code sequence.  
  48.  
  49. 3)  Huffman squeezing; the file is compressed into variable length bit 
  50.     strings, similar to the method used by the SQ programs.
  51.  
  52. Note that, since one of the three methods involves no compression at 
  53. all, the resulting archive entry will never be larger than the 
  54. original file.
  55.  
  56.  
  57.  
  58. USING ARC
  59. =========
  60.  
  61. ARC is invoked with a command of the following format:
  62.  
  63.     ARC <x> <arcname> [<template> . . .]
  64.  
  65. Where:
  66.  
  67.     <x> is an ARC command letter (see below), in either upper or lower 
  68.     case.  
  69.  
  70.     <arcname> is the name of the archive to act on, with or without an 
  71.     extension.  If no extension is supplied, then ".ARC" is assumed.  
  72.  
  73.     <template> is one or more file name templates.  The "wildcard" 
  74.     characters "*" and "?" may be used.  
  75.  
  76. If ARC is invoked with no arguments (by typing "ARC", and pressing 
  77. "enter"), then a brief command summary is displayed.
  78.  
  79.  
  80. ARC COMMANDS
  81. ============
  82.  
  83. Following is a brief summary of the available ARC commands:
  84.  
  85.     a,u = add files to archive
  86.     m   = move files to archive
  87.     d   = delete files from archive
  88.     x,e = extract files from archive
  89.     p   = copy files from archive to stdout
  90.     l   = list files in archive
  91.     b   = retain backup copy of archive
  92.     w   = suppress warning messages
  93.     n   = suppress notes and comments
  94.     t   = test archive integrity
  95.  
  96. These commands are explained in more detail below.
  97.  
  98.  
  99. ADD FILES TO ARCHIVE
  100. ====================
  101.  
  102. Files are added to an archive using the "A" (Add), "U" (Update), or 
  103. "M" (Move) commands.  Add and Update are identical.  Move differs in 
  104. that the source file is deleted once it has been added to the archive.
  105.  
  106. For example, if you wish to add a file named "TEST.DAT" to an archive 
  107. named "MY.ARC", you would use a command of the form:
  108.  
  109.     ARC a my test.dat
  110.  
  111. or:
  112.  
  113.     ARC u my.arc test.dat
  114.  
  115. If you wanted to move all files in your current directory into an 
  116. archive named "SUM.ARC", you could use a command of the form:
  117.  
  118.     ARC m sum *.*
  119.  
  120. If you wanted to add all files with a ".C" extension, and all files 
  121. named "STUFF" to an archive named "JUNK.ARC", you could type:
  122.  
  123.     ARC a junk *.c stuff.*
  124.  
  125. Archive entries are always maintained in alphabetic order.  Archive 
  126. entries may not have duplicate names.  If you add a file to an archive 
  127. that already contains a file by that name, then the existing entry in 
  128. the archive is replaced.  Also, the archive itself and its backup will 
  129. not be added.  
  130.  
  131.  
  132. DELETING FILES
  133. ==============
  134.  
  135. Archive entries are deleted with the "D" (Delete) command.  For 
  136. example, if you had an archive named "JUNK.ARC", and you wished to 
  137. delete all entries in it with a filename extension of ".C", you could 
  138. type: 
  139.  
  140.     ARC d junk *.c
  141.  
  142.  
  143. EXTRACTING FILES
  144. ================
  145.  
  146. Archive entries are extracted with the "E" (Extract) and "X" (eXtract) 
  147. commands.  For example, if you had an archive named "JUNK.ARC", and 
  148. you wanted all files in it with an extension of ".TXT" or ".DOC" to be 
  149. recreated on your disk, you could type:
  150.  
  151.     ARC x junk *.txt *.doc
  152.  
  153. If you wanted to extract all of the files in an archive named 
  154. "JUNK.ARC", you could simply type:
  155.  
  156.     ARC x junk
  157.  
  158. Whatever method of file compression was used in storing the files is 
  159. reversed, and uncompressed copies are created in the current 
  160. directory.
  161.  
  162.  
  163. PRINTING FILES
  164. ==============
  165.  
  166. Archive entries may be examined with the "P" (Print) command.  This 
  167. works the same as the Extract command, except that the files are not 
  168. created on disk.  Instead, the contents of the files are written to 
  169. standard output.  For example, if you wanted to see the contents of 
  170. every ".TXT" file in an archive named "JUNK.ARC", but didn't want them 
  171. saved on disk, you could type:
  172.  
  173.     ARC p junk *.txt
  174.  
  175. If you wanted them to be printed on your printer instead of on your 
  176. screen, you could type:
  177.  
  178.     ARC p junk *.txt >prn
  179.  
  180.  
  181. LISTING ARCHIVE ENTRIES
  182. =======================
  183.  
  184. You can obtain a list of the contents of an archive by using the "L" 
  185. (List) command.  For example, to see what is in an archive named 
  186. "JUNK.ARC", you could type:
  187.  
  188.     ARC l junk
  189.  
  190. If you are only interested in files with an extension of ".DOC", then 
  191. you could type:
  192.  
  193.     ARC l junk *.doc
  194.  
  195. ARC lists the archive contents in a table like this:
  196.  
  197. Name          Length    Comp   SF   Date       Time
  198. ============  ========  ====  ====  =========  ======
  199. ALPHA.TXT          512   --     0%  13 Apr 85   0:29a
  200. BRAVO.TXT          512  Pack   43%  15 Apr 85  11:51a
  201. COCO.TXT          1530   SQ    30%   8 Apr 85   1:35p
  202.  
  203. "Name" is simply the name of the file.
  204.  
  205. "Length" is the unpacked file length.  In other words, it is the 
  206. number of bytes of disk space which the file would take up if it were 
  207. extracted.
  208.  
  209. "Comp" is the compression method used on the entry.  The following 
  210. compression methods are currently employed:
  211.  
  212.      --       No compression.
  213.     Pack      Runs of repeated byte values are collapsed.
  214.      SQ       Huffman squeeze technique employed.
  215.  
  216. "SF" is the stowage factor.  In other words, it is the percentage of 
  217. the file length which was saved by compression.
  218.  
  219. "Date" and "Time" are the date and time that the file had last been 
  220. modified at the time when it was added to the archive.
  221.  
  222.  
  223. BACKUP RETENTION
  224. ================
  225.  
  226. When ARC adds or deletes archive entries it renames the original 
  227. archive to give it an extension of ".BAK", and then creates a new 
  228. archive with the desired changes.  If you wish to retain this original 
  229. copy of the archive for backup purposes, then add the "B" (Backup) 
  230. command to your other commands.
  231.  
  232. For example, if you wanted to delete all entries with an extension of 
  233. ".DOC" from an archive named "JUNK.ARC", but you wanted to keep a copy 
  234. around that still has them, then you could type:
  235.  
  236.     ARC bd junk *.doc
  237.  
  238. or:
  239.  
  240.     ARC db junk *.doc
  241.  
  242.  
  243. MESSAGE SUPPRESION
  244. ==================
  245.  
  246. ARC prints two types of messages, warnings and comments.
  247.  
  248. Warnings are messages about suspected error conditions, such as when a 
  249. file to be extracted already exists, or when an extracted file fails 
  250. the CRC error check.  Warnings may be suppressed by use of the "W" 
  251. (Warn) command.  You should use this command sparingly.  In fact, you 
  252. should probably not use this command at all.
  253.  
  254. Comments (or notes) are informative messages, such as naming each file 
  255. as it is added to the archive.  Comments and notes may be suppressed 
  256. by use of the "N" (Note) command.
  257.  
  258. For example, suppose you extracted all files with an extension of 
  259. ".BAS" from an archive named "JUNK.ARC"  Then, after making some 
  260. changes which you decide not to keep, you decide that you want to 
  261. extract them all again, but you don't want to be asked to confirm 
  262. every one.  In this case, you could type:
  263.  
  264.     ARC xw junk *.bas
  265.  
  266. Or, if you are going to add a hundred files with an extension of 
  267. ".MSG" to an archive named "TRASH.ARC", and you don't want ARC to list 
  268. them as it adds them, you could type:
  269.  
  270.     ARC an trash *.msg
  271.  
  272. Or, if you want to extract the entire contents of an archive named 
  273. "JUNK.ARC", and you don't want to hear anything, then type:
  274.  
  275.     ARC xnw junk
  276.  
  277.  
  278. TESTING AN ARCHIVE
  279. ==================
  280.  
  281. The integrity of an archive may be tested by use of the "T" (Test) 
  282. command.  This checks to make sure that all of the file headers are 
  283. properly placed, and that all of the files are in good shape.
  284.  
  285. This can be very useful for critical archives, where data integrity 
  286. must be assured.  When an archive is tested, all of the entries in the 
  287. archive are unpacked (without saving them anywhere) so that a CRC 
  288. check value may be calculated and compared with the recorded CRC 
  289. value.
  290.  
  291. For example, if you just received an archive named "JUNK.ARC" over a 
  292. phone line, and you want to make sure that you received it properly, 
  293. you could type:
  294.  
  295.     ARC t junk
  296.  
  297. It defeats the purpose of the T command to combine it with N or W.
  298.  
  299.  
  300. SPECIAL NOTES
  301. =============
  302.  
  303. Whenever ARC encounters a fatal error condition it leaves the original 
  304. archive on disk, renamed to have an extension of ".BAK" (backup).
  305.  
  306. The function used to calculate the CRC check value in previous 
  307. versions has been found to be in error.  It has been replaced in 
  308. version 3.0 with a proper function.  ARC will still read archives 
  309. created with earlier versions of ARC, but it will report a warning 
  310. that the CRC value is in error.  All archives created prior to version 
  311. 3.0 should be unpacked and repacked with the latest version of ARC.
  312.  
  313. Transmitting a file with XMODEM protocol rounds the size up to the 
  314. next multiple of 128 bytes, adding garbage to the end of the file.  
  315. This used to confuse ARC, causing it to think that the end of the 
  316. archive was invalidly formatted.  This has been corrected in version 
  317. 3.03.  Older archives may still be read, but ARC may report them to be 
  318. improperly formatted.  All files can be extracted, and no data is 
  319. lost.  In addition, ARC will automatically correct the problem when it 
  320. is encountered.
  321.