home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 9 Archive / 09-Archive.zip / arcid122.zip / ARCID.DOC < prev    next >
Text File  |  1996-07-16  |  12KB  |  275 lines
  1.  
  2.     ┌──────────────────────────────┐
  3.     │                              │
  4.     │  ╖────╖            ╖     ┐   │           Archive Identifier
  5.     │  ║    ║            ║     │   │
  6.     │  ║────╢ ┐──┐ ┌──┐  ║ ┌───│   │              Version 1.22
  7.     │  ║    ║ │    │     ║ │   │   │
  8.     │  ╜    ╜ ┘    └──┘  ╜ └───┘   │  (c) Copyright 1992-1996 - Stacy Smith
  9.     │                              │
  10.     └──────────────────────────────┘
  11.  
  12.                                   Courtesy of:
  13.  
  14.                          The Bloom Beacon-Picayune BBS
  15.         Node 1: *** DOWN *** (USRobotics Courier Dual Standard HST/V.34)
  16.                                     FidoNet
  17.                                      ILink
  18.                                     Intelec
  19.  
  20.                                   Stacy Smith
  21.  
  22.  
  23. ┌────────────────────┐
  24. │  1. Introduction:  │
  25. └────────────────────┘
  26.  
  27. Archive Identifier (ARCID) is a derivative of the UpLoadProcessor (ULP) system;
  28. users of ULP do not require this program, as each of the ULP programs have
  29. ARCID's abilities built into it.
  30.  
  31. ARCID is intended for use by people who wish to be able to accurately detect a
  32. archive's format without relying on the file extension, but do not wish to use
  33. ULP.  These people may be sysops using EXZTEST, ZIPLAB, ZDCS, FWKCS, etc., or
  34. may be using their own homemade batch files for testing archives, or even other
  35. purposes I haven't thought of.
  36.  
  37. Regardless, ARCID is an extremely simple and fast tool for people who deal with
  38. compressed files on a regular basis.
  39.  
  40.  
  41. ┌──────────────────────────────────────┐
  42. │  2. Features of Archive Identifier:  │
  43. └──────────────────────────────────────┘
  44.  
  45.       ∙ Native versions for both 16-bit DOS and 32-bit OS/2!
  46.       ∙ Identifies ARC, ARJ, HYP, LZH, PAK, RAR, SQZ, ZIP, ZOO, GIF, JPG and
  47.         BMP files, regardless of their file extensions (ideal for software
  48.         distribution networks, like .SDN files).
  49.       ∙ Identifies ARJ, LZH, RAR, SQZ and ZIP self-extracting (SFX) archives.
  50.       ∙ Can filter other file types based solely upon file extension.
  51.       ∙ A total of 97 archive formats and files extensions can be defined for
  52.         conditional branching of batch files.
  53.       ∙ Fully network-aware using DOS SHARE-compatible locks.
  54.       ∙ Written in C for optimal speed, using Watcom C/C++ 10.6.
  55.  
  56.  
  57. ┌───────────────────────────────────────────────────────┐
  58. │  3. Files Included in the ARCID Distribution Archive  │
  59. └───────────────────────────────────────────────────────┘
  60.  
  61.         ARCID.COM       Archive Identifier processing program (16-bit DOS).
  62.         ARCID2.EXE      Archive Identifier processing program (32-bit OS/2).
  63.         PCBTEST.BAT     Sample PCBTEST.BAT file for using ARCID.
  64.         SLOWDRV.BAT     Sample SLOWDRV.BAT file for using ARCID.
  65.         ARCID.DOC       This file.
  66.         SUPPORT.DOC     List of authorized support sites for my shareware.
  67.         HISTORY.DOC     ARCID revision history in reverse order.
  68.         REGISTER.FRM    Registration form for ARCID and other software.
  69.         FILE_ID.DIZ     Internal description file.
  70.  
  71. When you unzip the distribution archive, you should see my PKZIP authenticity
  72. verification stamp, and a '-AV' after every file in the archive:
  73.  
  74.         # SSU301    The Bloom Beacon-Picayune BBS
  75.  
  76. If there are any files missing or added, or the -AV stamp is missing, the
  77. archive has been tampered with.  It would be advisable to call my BBS (listed
  78. at the top of this document) or one of the support sites listed in the
  79. SUPPORT.DOC file for the latest version of ARCID.
  80.  
  81.  
  82. ┌───────────────────────────┐
  83. │  4. Program Requirements  │
  84. └───────────────────────────┘
  85.  
  86. To the best of my knowledge, this program will run on most any machine capable
  87. of running the popular archivers in use today.  My BBS setup was DESQview on a
  88. LANtastic network, but other sysops that I have been in contact with have
  89. successfully implemented ARCID on setups with CD-ROMs and other varying
  90. hardware.
  91.  
  92. ARCID has been developed and tested using archives created by the following
  93. archiving packages:
  94.  
  95.         ARJ 2.10 and higher (by Robert Jung)
  96.         HYPER 2.5 (by P. Sawatzki and K. P. Nischke)
  97.         LHA 2.12 and higher (by Haruyasu Yoshizaki)
  98.         LHarc 1.13c (by Haruyasu Yoshizaki)
  99.         PAK 2.51 (by NoGate Consulting)
  100.         PKPAK 3.61 (by PKWare)
  101.         PKZIP 1.10 and higher (by PKWare)
  102.         RAR 1.53 and higher (by Eugene Roshal)
  103.         SQZ 1.08.2 (by Jonas Hammarberg)
  104.         ZOO 2.01 and higher (by Rahul Deshi)
  105.         UnZip 5.12 (by Info-ZIP)
  106.         ZIP 2.0.1 (by Adler, Wales, Gailly and Rommel)
  107.  
  108. as well as the GIF87a, GIF89a, JPEG JFIF and BMP graphic format standards.
  109.  
  110. The ARCID system requires DOS 3.x and up or OS/2 2.x and up, as it uses DOS
  111. SHARE-compatible file reads and writes.
  112.  
  113. ARCID's memory requirements are extremely small (less than 64K).  For the batch
  114. file operations, however, it would be a good idea to have as much free
  115. conventional memory as possible (ARCID itself cannot use EMS or XMS memory, and
  116. really couldn't use it if I wanted it to), since the archivers may require a
  117. significant amount of memory.
  118.  
  119.  
  120. ┌───────────────────┐
  121. │  5. Registration  │
  122. └───────────────────┘
  123.  
  124. The ARCID system is not free; nor is ARCID is crippled to force registration.
  125. ARCID is fully functional, and will always remain so.  The only variation with
  126. the registered copies is no beg message and time delay.
  127.  
  128. Why register?  Besides a clean conscience, you will get a diskette that
  129. includes the latest version and a registration key that will work for all
  130. future versions of ARCID, and will remove the message and brief time delay at
  131. the end of execution of ARCID.
  132.  
  133. The registration fee for your unique code is $15 for non-commercial BBSes.  The
  134. registration fee for commercial BBSes, defined if you run your BBS in the
  135. course of a commercial business (e.g. more than 10 nodes), is $20.  Please
  136. print the file REGISTER.FRM and fill it out.  You can print out the form by
  137. issuing the following command from the DOS prompt:
  138.  
  139.         TYPE REGISTER.FRM > PRN
  140.  
  141.  
  142. ┌───────────────────────────────────────┐
  143. │  6. License, Warranty and Disclaimer  │
  144. └───────────────────────────────────────┘
  145.  
  146. I'll keep this part short and sweet, and dispense with the legal-ese:
  147.  
  148.     License: You are allowed to use ARCID for 30 days, after which you must
  149.         either register ARCID or stop using it completely.  ARCID registration
  150.         is a license for your use of ARCID; I retain ownership of the software.
  151.         A single registration applies to a single BBS system, regardless of the
  152.         number of computers used in the system.  If you run two or more
  153.         distinct BBS systems on the same computer (with different names), you
  154.         require two or more ARCID registrations.  Refer to the registration
  155.         form for the currect pricing structure.
  156.  
  157.     Warranty: There isn't one. The only thing I'll guarantee is that ARCID will
  158.         take up disk space, and will disappear when deleted.
  159.  
  160.     Disclaimer: I'm not responsible for anything bad that happens.  ARCID works
  161.         here, but I cannot be held responsible for it not working on your
  162.         computer or doing any damage to hardware or software.
  163.  
  164. If these aren't agreeable with you, then the best thing to do is delete ARCID
  165. right now.  I'll do my best to help any user (registered or not) that wants to
  166. use ARCID, and I'll act on bug reports quickly, but I simply cannot and will
  167. not be responsible for anything bad, like lost data, disk crashes, or whatever
  168. else you can think of.
  169.  
  170.  
  171. ┌───────────────────┐
  172. │  7. Installation  │
  173. └───────────────────┘
  174.  
  175. GENERAL:
  176. ────────
  177. Copy the file ARCID.COM into a subdirectory that is included in the DOS and/or
  178. OS/2 path, so that ARCID may be executed from anywhere.  I would suggest your
  179. PCB home directory, usually 'C:\PCB\'.  If you have registered ARCID, place
  180. a copy of your ARCID.KEY file in the same subdirectory as the ARCID
  181. executable(s).
  182.  
  183. If you are running your BBS under a DOS network or a multitasking operating
  184. system, you should already have DOS's SHARE.EXE loaded.  Some network operating
  185. systems (e.g. Novell) have integral SHARE functionality, therefore, SHARE.EXE
  186. is not required.  You must have SHARE-capability in order to take advantage of
  187. the file sharing and locking methods used by the DOS ARCID program to prevent
  188. data loss.  (If you are running a single-node system without a multitasker,
  189. SHARE is not needed).
  190.  
  191. Note that for the ARCID programs, you can obtain a limited program syntax
  192. screen simply by executing the program name with no arguments.
  193.  
  194. FOR UPLOAD TESTING USING 'PCBTEST.BAT':
  195. ───────────────────────────────────────
  196. NOTE: If you are unfamiliar with the operation of PCBTEST.BAT, you will need
  197. to refer to the PCBoard manual for an explanation of PCBTEST.BAT and/or
  198. TESTFILE.EXE.
  199.  
  200. As necessary, refer to the sample PCBTEST.BAT file included in this
  201. archive.  This simple batch file will test archive integrity and check for
  202. viruses for any of the detectable formats of ARCID.  This batch file can easily
  203. be expanded to perform more tests.
  204.  
  205. ARCID.COM is a drop-in replacement of PCBoard's TESTFILE.EXE.  If you are
  206. already using TESTFILE.EXE, then simply replace the TESTFILE command in your
  207. batch file with ARCID.  For example, if your current PCBTEST.BAT has the
  208. following line:
  209.  
  210.     TESTFILE %1 ZIP ARJ LZH GIF
  211.  
  212. simply change it to:
  213.  
  214.     ARCID %1 ZIP ARJ LZH GIF
  215.  
  216. ARCID will return a DOS errorlevel corresponding to the archive's position in
  217. the extension list; for example, if the file passed via %1 is an LZH file,
  218. ARCID will return an errorlevel of 3.  If the file is identified as one of the
  219. listed formats, ARCID will return an errorlevel of 98.  ARCID is capable of
  220. automatically detecting the formats identified by the following extensions,
  221. regardless of the file's true extension:
  222.  
  223.     ARC     for ARC/PKPAK archives
  224.     ARJ     for ARJ and ARJ self-extracting archives
  225.     BMP     for BMP picture files
  226.     GIF     for GIF picture files
  227.     HYP     for HYPER archives
  228.     JPG     for JPEG JFIF picture files
  229.     LZH     for LHA/LHARC and LHA/LHARC self-extracting archives
  230.     PAK     for PAK archives
  231.     RAR     for RAR and RAR self-extracting archives
  232.     SQZ     for SQZ and SQZ self-extracting archives
  233.     ZIP     for PKZIP and PKZIP self-extracting archives
  234.     ZOO     for ZOO version 2.x archives
  235.  
  236. Do not add 'EXE' to the extension list; ARCID will automatically return to
  237. corresponding errorlevel for an identified self-extracting archive.
  238.  
  239.  
  240. ┌──────────────────────────┐
  241. │  8. The Future of ARCID  │
  242. └──────────────────────────┘
  243.  
  244. ARCID will be supported as long as I'm in the BBSing business (which will be
  245. quite a while...once it's in your blood, you can never shake it <grin>).  The
  246. ARCID system will be rapidly expanding it's features; some current plans:
  247.  
  248.       ∙ Install code to detect archives containing explicit paths.
  249.       ∙ Install code to detect defective or hacked archives.
  250.  
  251. If you have any other suggestions, or want other archivers supported, please
  252. contact me by Internet, U.S. snail-mail or on my BBS at the number at the top
  253. of this document.
  254.  
  255. Thanks for giving ARCID a try!
  256.  
  257.  
  258. ┌────────────────────────────────┐
  259. │  Appendix A:  DOS Errorlevels  │
  260. └────────────────────────────────┘
  261.  
  262. The errorlevels returned to DOS by the ARCID system programs are consistent
  263. among all of the programs (primarily with the error conditions); the following
  264. is a list of the errorlevels than can be returned by the ARCID programs, along
  265. with which programs return the codes:
  266.  
  267.         0       Successful brand of the ARCID executable
  268.         1-97    Successful execution, archive identified
  269.         98      Successful execution, archive NOT identified
  270.         99      Unsuccessful execution, no arguments passed (help screen
  271.                    displayed)
  272.         110     Unable to allocate heap memory (disk buffer)
  273.         112     Invalid registration key
  274.         115     Invalid filename provided by user on command-line
  275.