home *** CD-ROM | disk | FTP | other *** search
/ Piper's Pit BBS/FTP: ibm 0000 - 0009 / ibm0000-0009 / ibm0003.tar / ibm0003 / ZIP122.ZIP / ZIP122.DOC < prev   
Encoding:
Text File  |  1988-08-19  |  11.7 KB  |  245 lines
  1.                                    ZIP.DOC
  2.                                    -------
  3.                            Instructions for ZIP.COM
  4.                    IBM PC Fast Serial File Transfer Utility
  5.                             Version 1.22 (8/19/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 (potentially) 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 to get copies of (the same version of) ZIP.COM 
  38. on both computers.  (You can accomplish this at 19200 bps using your serial 
  39. cable, if both machines have 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.  Large transfer jobs will go faster 
  63. if you use a hard or RAM disk, rather than a floppy drive, where possible.
  64.  
  65.      ZIP can be aborted by pressing any key:
  66.               (1) on either end, during initial handshaking
  67.               (2) on sending end, during file transfer
  68.                     (will abort once current file is finished)
  69.  
  70.  
  71.                              SELECTING THE SPEED
  72.  
  73.      By default ZIP works at 115200 bps.  In case you should have trouble at 
  74. this speed, ZIP has two command line options that request a slower speed:
  75.  
  76.               /M   = Use the moderate speed (57600 bps).
  77.               /S   = Use the slow speed (38400 bps).
  78.  
  79. Naturally these must be specified on BOTH ends, if used.  You will see an 
  80. additional note in the ZIP signon message, "Speed=_", indicating a slower 
  81. speed has been selected.
  82.  
  83.  
  84.                           SELECTING THE SERIAL PORT
  85.  
  86.      Most IBM computers have anywhere from one to four serial (RS232) ports.  
  87. (Some have none.  Tsk, tsk: time to add one!)  The first two, COM1 and COM2, 
  88. are implemented at standard addresses (03F8, 02F8); COM3 and COM4, if present, 
  89. can vary from one computer to another.  To use them you will have to install 
  90. the appropriate address in ZIP.COM (see below).
  91.  
  92.      ZIP has two command line options that you can specify (once, after any 
  93. filename(s) present) on either end, to determine which of the two standard 
  94. serial ports is used:
  95.  
  96.               /1   = Use the COM1 port.  (This is normally the default.)
  97.               /2   = Use the COM2 port.
  98.  
  99. You will see a note in the ZIP signon message, "Port=____", giving the port 
  100. address in use.
  101.  
  102.  
  103.                                 USAGE EXAMPLES
  104.  
  105.      C>zip \work\my         sends file C:\WORK\MY
  106.  
  107.      C>zip gort,klaatu /s   sends C:GORT, C:KLAATU at slow speed
  108.  
  109.      C>zip my.* /2          sends all files C:MY.* over COM2
  110.  
  111.      C>zip                  receives files into current directory
  112.  
  113.      C>zip \work\           receives files into directory C:\WORK\
  114.  
  115.      C>zip d: /2            receives files over COM2 into directory D:
  116.  
  117.  
  118.  
  119.                               TECHNICAL DETAILS
  120.  
  121.      ZIP does full CRC (Cyclic Redundancy Checksum) verification on the 
  122. received file.  Being designed for direct serial transfer at maximum hardware 
  123. speed, ZIP is not compatible with other software, including ordinary telcom 
  124. programs.  Do not disturb the cable when ZIP is running, as this may cause the 
  125. program to stall, requiring a reboot of your computer(s).
  126.  
  127.      Be sure to use the SAME version of ZIP on both ends: the transfer 
  128. protocol may have changed.  Otherwise, if you can't get ZIP to transfer files, 
  129. your computer(s) or your cable are incompatible.  ZIP is written entirely in 
  130. assembly language; it will only work on fully IBM compatible computers.  I 
  131. have tested it myself on 8088 PC clones with clock speeds of 4.77 to 8 MHz; I 
  132. rely on users' reports that it works well on more sophisticated systems.
  133.  
  134.      Serial cables can be wired in many different ways.  The one I use was 
  135. labeled as an "IBM AT adapter", and had female connectors on both ends (one 
  136. DB9, one DB25).  Any cable that doesn't work by itself should with a null 
  137. modem adapter.  Basically, you need to have the transmit and receive data 
  138. lines (pins 2 and 3 on a DB25) crossed, and ground (7) straight through.  If 
  139. you have to build your own cable, you'll discover whether any more connections 
  140. are needed.  Don't ask me for further advice: I don't know any more about this 
  141. than you do!
  142.  
  143.  
  144.                             MODIFYING THE DEFAULTS
  145.  
  146.      If no command-line option is given, ZIP will use its built-in "defaults" 
  147. for the serial port address and speed.  These values appear in simple ASCII 
  148. text form at the start of ZIP.COM, and can be modified to customize your copy 
  149. of ZIP.  To get a quick look at the current settings, just enter:
  150.  
  151.                       A>type zip.com
  152.                       __[Defaults: Port=03F8. Speed=F.]
  153.  
  154.      For the Port, you can use "03F8" (COM1), "02F8" (COM2), or whatever (see 
  155. your computer manual for COM3 or COM4 port addresses).  The possible values 
  156. for Speed are "F", "M", or "S".  Changes can be made with any patching 
  157. utility, such as DEBUG.  Just change the data under "Defaults:" to whatever 
  158. you require.  After modifying the defaults, you can still use any command-line 
  159. options above to override them.
  160.      Here is how the DEBUG session might look; we Display the default data, 
  161. Enter 0"2"F8 in place of the 03F8 to change to a default of COM2, Display 
  162. again to see the new value, Write the change to the file, and then Quit:
  163.  
  164. C:\WORK>debug zip.com
  165. -d100,11F
  166. xxxx:0100  EB 20 5B 44 65 66 61 75-6C 74 73 3A 20 50 6F 72   . [Defaults: Por
  167. xxxx:0110  74 3D 30 33 46 38 2E 20-53 70 65 65 64 3D 46 2E   t=03F8. Speed=F.
  168. -e113 32
  169. -d100,11F
  170. xxxx:0100  EB 20 5B 44 65 66 61 75-6C 74 73 3A 20 50 6F 72   . [Defaults: Por
  171. xxxx:0110  74 3D 30 32 46 38 2E 20-53 70 65 65 64 3D 46 2E   t=02F8. Speed=F.
  172. -w
  173. Writing xxxx bytes
  174. -q
  175.  
  176.      For further information on DEBUG see your MSDOS manual.  Please DO NOT 
  177. distribute modified copies of ZIP.COM; this could confuse other users.  They 
  178. are for your personal use only.
  179.  
  180.  
  181.                           ZIP 1.22 TRANSFER PROTOCOL
  182.  
  183.      This information is provided for programmers interested in writing 
  184. applications compatible with ZIP on other computer systems.  (If you do this, 
  185. please let me know.  MAC-ZIP, anyone?)  The current protocol is new with ZIP 
  186. 1.22.  The protocol may need to be modified again with future development of 
  187. ZIP.  All transfer takes place at 115200 bps (unless a slower speed is 
  188. selected); be aware that very tight polling loops, minimal handshaking, and 
  189. fixed packet size are needed to avoid loss of data at 115200 bps.
  190.  
  191.      The initial handshaking involves the receiver sending a version code byte 
  192. (122 decimal, for ZIP 1.22 protocol) at intervals until it is acknowledged 
  193. (ACK, 6 decimal) by the sender.  From this point on all data transfer is in 
  194. fixed-size packets.
  195.      The receiver, when ready, requests each packet by sending an ENQ (5 
  196. decimal).  Each packet has a 3-byte header, consisting of an SOH (1 decimal) 
  197. and a 16-bit count to indicate the number of significant bytes in the packet; 
  198. then exactly 512 bytes of data; then a concluding ETX (3 decimal).
  199.      The first packet contains the file name; an empty name packet (0 bytes 
  200. length) signifies the end of the transmission.  Subsequent packets contain the 
  201. file data; a packet that is less than full (count less than 512) signifies the 
  202. end of the file.  One final packet contains the 16-bit CCITT CRC value for the 
  203. entire file, the DOS time stamp word, and the DOS date stamp word, in that 
  204. order (6 bytes).
  205.      The receiver looks for the SOH and ETX bounding each packet, but does no 
  206. further checking.  There are no timeouts.  No attempt is made to resend 
  207. packets; under normal circumstances, transmission errors should not occur.  
  208. Upon any serious error, a NAK (21 decimal) is sent to the other end before 
  209. exiting to DOS.  Upon receipt of this signal, the other end also terminates.
  210.  
  211.  
  212.                                 ERROR MESSAGES
  213.  
  214.             <ERROR>  invalid command (probably illegal option).
  215.     <OUT OF MEMORY>  less than 64K free RAM available.
  216.          <TOO MANY>  global filespec includes too many files.
  217.        <FILE ERROR>  trouble reading or writing a disk file.
  218.      <COMM FAILURE>  transmission error; or, aborted at the other end.
  219.         <CRC ERROR>  received file CRC did not match, bad transfer.
  220.           <ABORTED>  you pressed a key.
  221.  
  222.  
  223.                                    HISTORY
  224.  
  225. ZIP 1.0  (4/88) - trial release.  Worked on many systems.
  226.     1.1  (4/88) - improved transmission algorithm; batch transfers allowed 
  227.                  using wildcards and/or commas; receive directory option; 
  228.                  original file time/date preserved.
  229.     1.2  (5/88) - improved error handling; patchable default port also 
  230.                  allows use of COM3,4; small bug fixes.
  231.    1.21  (5/88) - slower speed options; fixed bug in initializing ports.
  232.    1.22  (8/88) - protocol modified for better results on computers of
  233.                  widely different speeds; fixed bug in deleting temp file.
  234.  
  235.      ZIP and its documentation are (c)1988 E. Meyer, all rights reserved.  
  236. They may be freely distributed, but not modified or sold for profit without 
  237. my written consent.  The user takes full responsibility for any damages 
  238. resulting from the use (or misuse) of this program.  Please report any 
  239. problems encountered.
  240.  
  241.                  Eric Meyer
  242.             401 12th Ave SE, #139            CompuServe [74415,1305]
  243.               Norman, OK  73071
  244.  
  245.