home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / util2 / zip.lzh / ZIP.DOC < prev   
Text File  |  1988-11-26  |  12KB  |  241 lines
  1.                                    ZIP.DOC
  2.                                    -------
  3.                            Instructions for ZIP.COM
  4.                    IBM PC Fast Serial File Transfer Utility
  5.                              Version 1.21 (05/88)
  6.  
  7.                                (c)1988 E. Meyer
  8.  
  9.       Requires:  100% IBM PC compatible computers;  MS/PCDOS 2.x or 3.x
  10.  
  11.  
  12.      ZIP is a tiny, fast utility to transfer files between two IBM compatible 
  13. computers over an ordinary serial cable connection.  This is most useful when 
  14. the computers don't share a common disk format, as in the case of a desktop PC 
  15. with 5" drives and a laptop (or PS/2) with only a 3" drive.  ZIP is easier to 
  16. use, and over 6 times faster, than any ordinary telcom program.
  17.  
  18.               Telcom programs: modem       2400 bps      0.3 K/sec
  19.               Telcom programs: cable      19200 bps      2.3 K/sec
  20.         --->  ZIP: cable                 115200 bps     14.1 K/sec
  21.  
  22.      Most computer manufacturers offer additional disk drives or other 
  23. hardware accessories to provide access to data on both 3" and 5" disks; but 
  24. these can cost hundreds of dollars.  They can also make a laptop computer a 
  25. lot less than portable.  Direct serial connection isn't quite as fast, but it 
  26. does allow a data rate of 115200 baud -- that's over 14K per second.
  27.  
  28.      There are commercial programs for this purpose (of which LapLink may be 
  29. the best known).  I'm sure they work very well, and have many extra 
  30. conveniences that ZIP lacks.  But even they are priced at $100 and up, which 
  31. is far more than I was willing to pay.  ZIP transfers files just as well, and 
  32. is free.
  33.  
  34.  
  35.                                   BASIC USE
  36.  
  37.      Obviously, you will need a copy of ZIP.COM on both computers.  (You can 
  38. accomplish this at 19200 bps using your serial cable, if both machines have 
  39. telcom software with XMODEM protocol transfers.)
  40.  
  41.      ZIP makes transferring a file as easy as copying it from one disk to 
  42. another.  To transfer any MSDOS file, once the cable is properly connected to 
  43. the COM ports of the two computers, from any DOS prompt:
  44.  
  45.      (1) On the sending machine, type:        C>zip FILENAME
  46.      (2) On the receiving machine, type:      C>zip
  47.                                           or  C>zip DIRECTORY
  48.  
  49. (Don't try to hit RETURN at exactly the same time on both ends; this actually 
  50. makes an initial handshaking error more likely.)
  51.  
  52.      The "FILENAME" you give can be a single file, or a GROUP specified by 
  53. wildcards and/or commas (see examples below).  Each name may include a 
  54. directory.  Each file will appear with the same name on the receiving end.  
  55. As data is transferred you should see a blinking asterisk.  When you see the 
  56. message "Verified", you know that the received copy exactly matches the 
  57. original.
  58.  
  59.      The "DIRECTORY" may optionally be specified on the receiving end; 
  60. otherwise, files are received in the current directory.  Note: the directory 
  61. MUST end with either a colon ":" or a backslash "\", otherwise ZIP will think 
  62. it's a FILE to SEND!  See examples below.
  63.  
  64.      ZIP can be aborted by pressing any key:
  65.               (1) on either end, during initial handshaking
  66.               (2) on sending end, during file transfer
  67.                     (will abort once current file is finished)
  68.  
  69.  
  70.                              SELECTING THE SPEED
  71.  
  72.      By default ZIP works at 115200 bps.  In case you should have trouble at 
  73. this speed, ZIP has two command line options that request a slower speed:
  74.  
  75.               /M   = Use the moderate speed (57600 bps).
  76.               /S   = Use the slow speed (38400 bps).
  77.  
  78. Naturally these must be specified on BOTH ends, if used.  You will see an 
  79. additional note in the ZIP signon message, "Speed=_", indicating a slower 
  80. speed has been selected.
  81.  
  82.  
  83.                           SELECTING THE SERIAL PORT
  84.  
  85.      Most IBM computers have anywhere from one to four serial (RS232) ports.  
  86. The first two, COM1 and COM2, are implemented at standard addresses (03F8, 
  87. 02F8); COM3 and COM4, if present, can vary from one computer to another.  To 
  88. use them you will have to install the appropriate address in ZIP.COM (see 
  89. below).
  90.  
  91.      ZIP has two command line options that you can specify (once, after any 
  92. filename(s) present) on either end, to determine which of the two standard 
  93. serial ports is used:
  94.  
  95.               /1   = Use the COM1 port.  (This is normally the default.)
  96.               /2   = Use the COM2 port.
  97.  
  98. You will see a note in the ZIP signon message, "Port=____", giving the port 
  99. address in use.
  100.  
  101.  
  102.                                 USAGE EXAMPLES
  103.  
  104.      C>zip \work\my         sends file C:\WORK\MY over COM1
  105.  
  106.      C>zip gort,klaatu /s   sends C:GORT, C:KLAATU over COM1 at slow speed
  107.  
  108.      C>zip my.* /2          sends all files C:MY.* over COM2
  109.  
  110.      C>zip                  receives files over COM1 into current directory
  111.  
  112.      C>zip \work\           receives files over COM1 into directory C:\WORK\
  113.  
  114.      C>zip d: /2            receives files over COM2 into directory D:
  115.  
  116.  
  117.  
  118.                               TECHNICAL DETAILS
  119.  
  120.      ZIP does full CRC (Cyclic Redundancy Checksum) verification on the 
  121. received file.  Being designed for direct serial transfer at maximum hardware 
  122. speed, ZIP is not compatible with other software, including ordinary telcom 
  123. programs.  Do not disturb the cable when ZIP is running, as this may cause the 
  124. program to stall, requiring a reboot of your computer(s).
  125.  
  126.      Be sure to use the SAME version of ZIP on both ends: the transfer 
  127. protocol may have changed.  Otherwise, if you can't get ZIP to transfer files, 
  128. your computer(s) or your cable are incompatible.  ZIP is written entirely in 
  129. assembly language; it will only work on fully IBM compatible computers.  I 
  130. have tested it myself on 8088 PC clones with clock speeds of 4.77 to 8 MHz; I 
  131. rely on users' reports that it works well on more sophisticated systems.
  132.  
  133.      Serial cables can be wired in many different ways.  The one I use was 
  134. labeled as an "IBM AT adapter", and had female connectors on both ends (one 
  135. DB9, one DB25).  Any cable that doesn't work by itself should with a null 
  136. modem adapter.  If you find that you need to build a cable, don't ask me for 
  137. advice: I don't know any more about this than you do!
  138.  
  139.  
  140.                             MODIFYING THE DEFAULTS
  141.  
  142.      If no command-line option is given, ZIP will use its built-in "defaults" 
  143. for the serial port address and speed.  These values appear in ASCII form at 
  144. the start of ZIP.COM, and can be modified to customize your copy of ZIP.  To 
  145. get a quick look at the current settings, just enter:
  146.  
  147.                       A>type zip.com
  148.                       __[Defaults: Port=03F8. Speed=F.]
  149.  
  150.      For the Port, you can use "03F8" (COM1), "02F8" (COM2), or whatever (see 
  151. your computer manual for COM3 or COM4 port addresses).  The possible values 
  152. for Speed are "F", "M", or "S".  Changes can be made with any patching 
  153. utility, such as DEBUG.  Just change the data under "Defaults:" to whatever 
  154. you require.  After modifying the defaults, you can still use any command-line 
  155. options above to override them.
  156.      Here is how the DEBUG session might look; we Display the default data, 
  157. Enter 0"2"F8 in place of the 03F8 to change to a default of COM2, Display 
  158. again to see the new value, Write the change to the file, and then Quit:
  159.  
  160. C:\WORK>debug zip.com
  161. -d100,12f
  162. xxxx:0100  EB 20 5B 44 65 66 61 75-6C 74 73 3A 20 50 6F 72   . [Defaults: Por
  163. xxxx:0110  74 3D 30 33 46 38 2E 20-53 70 65 65 64 3D 46 2E   t=03F8. Speed=F.
  164. xxxx:0120  5D 1A E8 A8 06 0D 0A 5A-49 50 20 31 2E 32 31 20   ]......ZIP 1.21
  165. -e113 32
  166. -d100,12f
  167. xxxx:0100  EB 20 5B 44 65 66 61 75-6C 74 73 3A 20 50 6F 72   . [Defaults: Por
  168. xxxx:0110  74 3D 30 32 46 38 2E 20-53 70 65 65 64 3D 46 2E   t=02F8. Speed=F.
  169. xxxx:0120  5D 1A E8 A8 06 0D 0A 5A-49 50 20 31 2E 32 31 20   ]......ZIP 1.21
  170. -w
  171. Writing 0896 bytes
  172. -q
  173.  
  174.      For further information on DEBUG see your MSDOS manual.  Please DO NOT 
  175. distribute modified copies of ZIP.COM; this could confuse other users.  They 
  176. are for your personal use only.
  177.  
  178.  
  179.                           ZIP 1.2 TRANSFER PROTOCOL
  180.  
  181.      This information is provided for programmers interested in writing 
  182. applications compatible with ZIP on other computer systems.  The version 1.2 
  183. protocol may need to be modified with future development of ZIP.  All transfer 
  184. takes place at 115200 bps (unless a slower speed is selected); be aware that 
  185. very tight polling loops, minimal handshaking, and fixed packet size are 
  186. needed to avoid loss of data at 115200 bps.
  187.  
  188.      The initial handshaking involves the receiver sending a version code byte 
  189. (120 decimal, for 1.20) at intervals until it is acknowledged (ACK, 6 decimal) 
  190. by the sender.  From this point on all data transfer is in fixed-size packets.
  191.      The receiver, when ready, requests each packet by sending an ENQ (5 
  192. decimal), and acknowledges correct receipt with an ACK.  Each packet has a 3- 
  193. byte header, consisting of an SOH (1 decimal) and a 16-bit count to indicate 
  194. the number of significant bytes in the packet; then 512 bytes of data; then a 
  195. concluding ETX (3 decimal).
  196.      The first packet contains the file name; an empty name packet signifies 
  197. the end of the transmission.  Subsequent packets contain the file data; a 
  198. packet that is less than full (count less than 512) signifies the end of the 
  199. file.  One final packet contains the 16-bit CCITT CRC value for the entire 
  200. file, the DOS time stamp word, and the DOS date stamp word, in that order.
  201.      The receiver looks for the SOH and ETX bounding each packet, but does no 
  202. further checking.  There are no timeouts.  No attempt is made to resend 
  203. packets; under normal circumstances, transmission errors should not occur.  
  204. Upon any serious error, a NAK (21 decimal) is sent to the other end before 
  205. exiting to DOS.  Upon receipt of this signal, the other end also terminates.
  206.  
  207.  
  208.                                 ERROR MESSAGES
  209.  
  210.             <ERROR>  invalid command (probably illegal option).
  211.     <OUT OF MEMORY>  less than 64K free RAM available.
  212.          <TOO MANY>  global filespec includes too many files.
  213.        <FILE ERROR>  trouble reading or writing a disk file.
  214.      <COMM FAILURE>  transmission error; or, aborted at the other end.
  215.         <CRC ERROR>  received file CRC did not match, bad transfer.
  216.           <ABORTED>  you pressed a key.
  217.  
  218.  
  219.                                    HISTORY
  220.  
  221. ZIP 1.0 (04/88) - trial release.  Worked on many systems.
  222.     1.1 (04/88) - improved transmission algorithm; batch transfers allowed 
  223.                  using wildcards and/or commas; receive directory option; 
  224.                  original file time/date preserved.
  225.     1.2 (05/88) - improved error handling; patchable default port also 
  226.                  allows use of COM3,4; small bug fixes.
  227.    1.21 (05/88) - slower speed options; fixed bug in initializing ports.
  228.  
  229.  
  230.      ZIP and its documentation are (c)1988 E. Meyer, all rights reserved.  
  231. They may be freely distributed, but not modified or sold for profit without 
  232. my written consent.  The user takes full responsibility for any damages 
  233. resulting from the use (or misuse) of this program.  Please report any 
  234. problems encountered.
  235.  
  236.                  Eric Meyer
  237.             427 N. Washington #4             CompuServe [74415,1305]
  238.            Bloomington, IN  47401
  239.  
  240.  
  241.