home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / comm / term33in.lha / Documentation / XPR_Libs / xprzmodem.doc < prev    next >
Text File  |  1993-02-13  |  33KB  |  628 lines

  1.  
  2.                     Documentation for XPRZModem.library
  3.               Version 2.10, 12 February 1991, by Rick Huebner
  4.  
  5. |---
  6. |           Update comments for XprZmodem.Library
  7. |    Version 2.50 Update, 15 November 1991, by William M. Perkins
  8. |    Version 2.51 bug fix, 29 January 1992, by John Tillema
  9. |    Version 2.52 recompiled, 6 March 1992, by William M. Perkins
  10. |      Proto additions for the SAS 5.10B Compiler by Jim Cooper
  11. |---
  12.  
  13. |---
  14. |    All of my additions to this documentation are indicated by
  15. |  <--  this left margin braketing.   -WMP-
  16. |---
  17.  
  18. 1.  Introduction (or "What is this thing, anyway?")
  19. ---------------------------------------------------
  20.  
  21.      XPRZModem.library is an Amiga shared library (with full Lattice C
  22. source code) which provides ZModem file transfer capability to any
  23. XPR-compatible communications program.  The XPR external protocol standard
  24. describes an interface method which allows various file transfer protocols
  25. to be implemented as Amiga shared libraries which may then be used
  26. interchangeably in any compatible communications program.  This takes a
  27. heavy load off of the comm program author, who no longer has to support
  28. scads of different file transfer protocols (many of which are quite tricky
  29. to code) in their program in order to make it widely useful and popular.
  30. The comm program is also smaller and more efficient as a result, since all
  31. those obscure protocols (you know, the ones *you* don't need) are no longer
  32. taking up space.  The XPR standard also helps users, who can mix and match
  33. their favorite file transfer protocols (and implementations thereof) with
  34. their favorite comm programs.  And when new protocols are invented, the
  35. user simply plugs in a new library, and voila!, it's ready to use.
  36. Hopefully, making protocols easy to support will allow more and better comm
  37. programs to be written, as authors can concentrate on their programs
  38. instead of constantly re-inventing the wheel.
  39.  
  40.      Of course, for all of this wonderful stuff to happen, there needs to
  41. be a good selection of these XPR protocol libraries available to the
  42. public.  It's the classic chicken-and-egg problem; comm program authors
  43. won't be motivated to support the XPR standard unless there are a goodly
  44. number of protocols available for it.  And other programmers won't be
  45. motivated to write XPR protocol libraries until there are a goodly number
  46. of comm programs which can use them.  In an effort to do my bit [ B^) ] for
  47. the Amiga community, which has given me so many neat toys to play with over
  48. the past few years, I decided to try and help get the ball rolling.
  49.  
  50.      Hopefully, the early availability of a ZModem library will help
  51. stimulate interest in the XPR standard, resulting in better Amiga telecomms
  52. for all of us.  And by making my source code PD, I hope to help others
  53. interested in writing XPR protocol libraries by giving them some serious
  54. example code.  Also, having ZModem library code readily available to John
  55. Q. Hacker should help ensure a steady stream of new lemon-fresh enhanced
  56. ZModem libraries (with enzymes) for all of us to use in the future.
  57.  
  58.      Of course, no discussion of the XPR standard would be complete without
  59. giving proper credit to the author, Willy Langeveld of the Stanford Linear
  60. Accelerator Center.  Many thanks are due him for this effort.  If you have
  61. any further questions about the XPR standard, be sure and download the spec;
  62. it should be available on BIX (since he's a sysop there), or on most other
  63. major systems.  And I'll try to keep the current version available on my
  64. BBS, as well.
  65.  
  66.      All files in this archive which are not copyrighted are hereby
  67. released to the public domain (which they were anyway, by way of not being
  68. copyrighted, but I want to make sure YOU realize that).  Do as you like
  69. with them.  Please make lots of copies and distribute them all over the
  70. place, and make lots of derivative works, and everything!  Heck, you can
  71. even publicly perform and/or display this code if you can figure out how...
  72.  
  73.  
  74.  
  75. 2.  Installation (OK, enough chatter; let's get to work)
  76. --------------------------------------------------------
  77.  
  78.      Couldn't be easier.  Just copy the xprzmodem.library file into your
  79. LIBS: directory.  All XPR-compatible comm programs should provide a way for
  80. you to select which XPR protocol you wish to use, either by giving you a
  81. file requester showing LIBS:xpr*.library, or by automatically detecting
  82. these libraries and adding them into their menus.
  83.  
  84. WARNING:  Versions of VLT prior to revision 4.107 had a bug in the
  85. xpr_sflush() routine which caused random Guru 3 crashes on some systems.  If
  86. you're using a version of VLT older than 4.107, it would be a good idea to
  87. upgrade to the latest rev.  Besides, there's a bunch of new features you're
  88. missing, anyway...
  89.  
  90. ANOTHER WARNING:  Versions of VLT prior to 5.034 had a bug in the
  91. xpr_sread() function which caused them to (at least sometimes) fail to
  92. return any bytes received so far when an xpr_sread() call timed out.  This
  93. version of XPRZModem.library requires VLT version 5.034 or later.  (Yes,
  94. Willy, it really was broken B-))
  95.  
  96. |---
  97. |    XprZmodem.Library version 2.50 and 2.52 tested with WTerm version
  98. |    0.82 and Willy's term program, VLT version 5.045.  No problems
  99. |    occurred.  It should work fine with any term program that was able
  100. |    to work with the version 2.10 of XprZmodem.Library.    -WMP-
  101. |---
  102.  
  103. 3.  Options
  104. -----------
  105.  
  106.      The XPR standard lays out two ways for the comm program user to
  107. specify options for the XPR protocol.  The more primitive option is for the
  108. comm program to provide a method of passing an option string to the XPR
  109. library before transferring files.  The precise format and usage of this
  110. option string is left up to the XPR protocol author; the comm program just
  111. sends it verbatim.  If an environment variable is found with the same name
  112. as the XPR protocol (i.e. there's a file in the ENV: directory called
  113. "xprzmodem"), the comm program is supposed to use this string (contents of
  114. file) to initialize the protocol options.  Also, a menu option or some such
  115. should normally be provided which will allow the user to be prompted for
  116. the option string interactively.
  117.  
  118.      Version 2.0 of the XPR standard created a new, more sophisticated way
  119. for the comm program user to specify XPR options.  If the comm program
  120. supports it, the XPR library can give the comm program a list of option
  121. prompts, and the comm program can then let the user interactively set the
  122. various options individually, possibly even using nice gadgets and stuff.
  123.  
  124.      In any case, no matter how your particular comm program feels like
  125. handling it, these are the options supported by this implementation of
  126. ZModem:
  127.  
  128.           T{Y|N|?|C}   Text translation mode:
  129.              TY = Text Yes; if receiving, translate CR/LF pairs or solo
  130.                   CR chars to normal Amiga LF chars.  Ignore data past ^Z.
  131.                   If sending, suggests to receiver that they should receive
  132.                   this file in text mode.
  133.              TN = Text No; receive file verbatim, without changes.  If
  134.                   sending, suggest to receiver that they receive this
  135.                   file verbatim, without translations.
  136.              T? = Text status unknown; if receiving, use sender's
  137.                   suggestion as to whether to do EOL translations or not.
  138.                   If sending, tell receiver to use default mode, 'cause we
  139.                   don't know either.
  140.              TC = Text mode set by Comm program; the library asks the comm
  141.                   program whether or not to use Text mode for each file.
  142.                   If the comm program doesn't support the necessary
  143.                   xpr_finfo() call, or if the call fails, this option acts
  144.                   like T?.  From the user's point of view, what this option
  145.                   normally does is set the Text mode to match the comm
  146.                   program's built-in text/binary/end-of-line/translation
  147.                   mode, if any.
  148.  
  149.           O{Y|N|R|S}  Overwrite mode:
  150.              OY = Overwrite Yes; if about to receive file with same name as
  151.                   one which already exists, delete the old file and receive
  152.                   the new file in its place.
  153.              ON = Overwrite No; if about to receive file with same name as
  154.                   one which already exists, append ".dup" onto the name of
  155.                   the new file to keep them separate.
  156.              OR = Overwrite Resume; if about to receive file with same name
  157.                   as one which already exists, resume receiving file data
  158.                   from the current end of the existing file.
  159.              OS = Overwrite Skip; if (etc.), tell sender never mind, skip
  160.                   this file, we don't want it.  Batch transfers will move
  161.                   on to the next file in the set, if any.
  162.  
  163.           Bnnn   Buffer size:
  164.              XPRZModem.library adds a layer of file I/O buffering in
  165.              addition to whatever the comm program may or may not provide.
  166.              This option sets the size of XPRZModem's file I/O buffer in
  167.              kilobytes.  The minimum value is 1 KB, for those using RAM
  168.              drives or fast hard drives, or those whose comm programs
  169.              already provide sufficient buffering.  The maximum value is
  170.              as much contiguous RAM as you have available in your Amiga.
  171.              If you specify more than is actually available, XPRZModem will
  172.              keep decrementing the buffer size requested by 1 KB until the
  173.              memory allocation works.  That way, if your RAM is too
  174.              fragmented to use the amount you request, XPRZModem simply
  175.              uses the largest block available.  Buffering is especially
  176.              helpful for floppy drive users; it keeps your drive from
  177.              continuously gronking and slowing things down all through the
  178.              transfer.  NOTE: Versions of VLT prior to 5.034 couldn't handle
  179.              buffer sizes >= 32 KB.  If you wanted to use larger buffers
  180.              before and couldn't, try again now.
  181.  
  182.           Fnnn   Frame size:
  183.              Although normally avoided, ZModem has the ability to require
  184.              an ACK to be sent from the receiver to the sender every X-many
  185.              data bytes.  Normally you don't want to use this feature,
  186.              because not waiting for ACKs is part of how ZModem works so
  187.              fast.  However, this feature can be very useful in conjunction
  188.              with file I/O buffering on slow devices (namely those floppy
  189.              drives).  If you set up a large I/O buffer to avoid gronking
  190.              your floppy so often, you'll find that when the buffer finally
  191.              *does* get around to being flushed that it can take a looonng
  192.              time; so long, in fact, that the delay can cause timeouts and
  193.              errors.  But if you set your ZModem to require the sender to
  194.              wait for an ACK every buffer's-worth of data, the sender will
  195.              politely wait for you to flush your buffer to the slow floppy
  196.              and send it an ACK saying it's OK to continue now.  This value
  197.              should be set to 0 to disable ACKs (normal mode), or set it to
  198.              the actual number of data bytes allowed between ACKs.  For
  199.              example, if you set B64 because of your floppy, you should
  200.              also set F65536.
  201.  
  202.           Ennn   Error count:
  203.              This allows you to set the number of sequential errors which
  204.              will be required to convince ZModem to abort the transfer.  The
  205.              normal value is 10, meaning that 10 errors must happen in a row
  206.              with no valid data being transferred in order to cause an abort.
  207.              This setting is provided for those using XPRZModem with a BBS,
  208.              who may wish to use a relaxed setting, or those with really
  209.              lousy phone lines who are desparate and patient enough to want
  210.              the transfer to continue in spite of horrible performance.
  211.  
  212.           A{Y|N}   Auto-activate mode:
  213.              AY = Auto-activate Yes; if the comm program supports the
  214.                   ability, the library will automatically go into receive
  215.                   mode when the start of a ZModem download is detected.
  216.              AN = Auto-activate No; don't try to automatically start
  217.                   downloading, make the user activate it.
  218.  
  219.           D{Y|N}   Delete after sending:
  220.              DY = Delete Yes; delete each file after it has been
  221.                   sucessfully sent.
  222.              DN = Delete No; don't delete files after sending them.
  223.  
  224.           K{Y|N}   Keep partial files:
  225.              KY = Keep Yes; keep the fragment of a file received so far
  226.                   if file reception is aborted.  This allows you to use the
  227.                   Overwrite Resume option above to pick up where you left
  228.                   off on your next attempt.
  229.              KN = Keep No; delete any partially-received file after an
  230.                   aborted transfer.
  231.  
  232.           S{Y|N}   Send full directory path:
  233.              SY = Send path Yes; send full filenames including directory
  234.                   path to receiver.
  235.              SN = Send path No; send only simple filenames, not including
  236.                   directory path.
  237.  
  238.           R{Y|N}   Receive full directory path:
  239.              RY = Receive path Yes; use full filename exactly as received,
  240.                   instead of using the P option directory path.
  241.              RN = Receive path No; ignore received directory path (if any),
  242.                   use P option directory path instead.
  243.  
  244.           P{dir}   Path to use for received files:
  245.              Px = Store all received files in directory "x" if option RN
  246.                   set.  Ignored if option RY set.  "x" can be any valid
  247.                   existing directory, with or without trailing "/"
  248.                   (e.g. "Pdf0:", "PComm:hold", etc.).
  249.  
  250.      If setting the options via the option string method (either ENV: file
  251. or primitive comm program), note that the setting for each option must
  252. immediately follow the option character with no intervening characters
  253. ("TY", not "T Y" or "T=Y").  When setting multiple options at once,
  254. separate the options from each other with commas and/or spaces; for
  255. example, "TN,OR,F0".  You don't have to specify all options every time; the
  256. options you specify will be merged into the current option settings,
  257. replacing their old values.  Upper/lower case is not significant.  The
  258. default option settings if you don't change anything are "TC, ON, B16, F0,
  259. E10, AY, DN, KY, SN, RN, P".
  260.  
  261.      If the comm program supports the xpr_options() call added in version
  262. 2.0 of the XPR spec, you should be prompted for each option with a nice
  263. prompt message such as "Text mode (Y,N,?,C):" and possibly be able to use
  264. Intuition string and/or button gadgets instead of being stuck with the
  265. semi-cryptic option string format described above.
  266.  
  267.  
  268.  
  269. 4.  Serial port settings
  270. ------------------------
  271.  
  272.      ZModem (at least this implementation of it) requires that your serial
  273. port be set to 8 data bits, no parity, 1 stop bit.  This allows ZModem to
  274. send full 8-bit binary data bytes without having them munged on the way
  275. through the modem.  If your comm program supports the xpr_setserial()
  276. function, XPRZModem will use it to set your serial port to 8N1 before doing
  277. a transfer, and will set your port back the way it was again after it's
  278. done.  If your comm program doesn't support xpr_setserial(), you'll need to
  279. make sure it's in 8N1 mode yourself.
  280.  
  281.      ZModem works well in all serial port handshaking modes; none,
  282. XON/XOFF, or 7-wire/RTS/CTS.  Since any or all of those handshaking modes
  283. may be appropriate at different times, with different modems or remote
  284. systems, XPRZModem lets you set the handshaking mode and doesn't mess with
  285. it.
  286.  
  287.  
  288.  
  289. 5.  Receiving files
  290. -------------------
  291.  
  292.      Once you get the ZModem options and your serial port configuration set
  293. up properly, you're ready to actually use this thing (gasp!).  Receiving
  294. files via ZModem is quite simple.  First, get the file sender going by
  295. using whatever command it wants.  ZModem is a batch file transfer protocol,
  296. meaning that it's capable of transferring several files in a single
  297. exchange, so the remote system may allow you to specify multiple files to
  298. be sent to you at one time.  It may also allow you to use wildcard
  299. characters in the filename(s); this is all system dependant.
  300.  
  301.      This may be all you have to do.  If you specified option AY
  302. (auto-activate on), and your comm program supports it, XPRZModem should
  303. automatically activate at this point and start receiving your files.  If
  304. you specified AN, or your comm program doesn't support auto-activation, you
  305. should now use whatever option your comm program provides to activate file
  306. reception; this will usually be a menu option or button gadget.  Either
  307. way, once XPRZModem starts receiving files, it should automatically receive
  308. all of the files you specified into the proper directory as indicated by
  309. the R and P options.
  310.  
  311.      Make sure that you have set the ZModem options properly before
  312. starting the transfer; especially, make sure you only use TY if you know
  313. that all of the files being transferred in this batch are printable ASCII
  314. text files.  If you use TY on normal binary files like .ARCs or .ZOOs,
  315. they'll be mangled beyond use.
  316.  
  317.  
  318.  
  319. 6.  Sending files
  320. -----------------
  321.  
  322.      Sending files using ZModem is fairly straightforward.  First, activate
  323. the file receiver with whatever command the remote system requires.  You
  324. may or may not need to specify a filename or directory to the remote
  325. system; this depends on their implementation of ZModem.  Once the remote
  326. system is ready to receive files, activate your comm program's ZModem send
  327. function.  Your comm program will prompt you for which file(s) to send.
  328. Although ZModem is a batch protocol, your comm program may or may not allow
  329. you to specify multiple file names to be sent; also, wildcards may or may
  330. not be supported.  These decisions are up to the comm program author;
  331. ZModem will handle multiple files and wildcards if the comm program allows
  332. them.  Once you've specified the file name(s), the file(s) will be sent to
  333. the remote system.  Note that the T option serves only as a suggestion to
  334. the receiving system when sending files; the receiver makes the final
  335. decision as to whether to take your advice or to force the files to be
  336. received in text or binary mode.
  337.  
  338.      If errors occur while sending the file(s), you'll probably notice a
  339. small enhancement I made to the normal ZModem error recovery procedures.
  340. Normally, file transfer protocols have to compromise between efficient data
  341. transmission on good, clean phone lines and quick error recovery on bad,
  342. noisy phone lines.  If you pick a large packet size, you get high
  343. throughput on clean lines due to low packet overhead, but you have slow
  344. recovery times and large amounts of retransmitted data on noisy lines.  If
  345. you've used YModem on noisy lines you've seen this problem.  But, if you
  346. use small packets to reduce retransmitted data on noisy lines, you increase
  347. the amount of time the protocol spends sending packet overhead, and your
  348. throughput suffers.  The solution is to vary the block size according to
  349. the experienced error rate during the transfer.  That way you aren't stuck
  350. with a rigid packet length which will sometimes be the wrong size no matter
  351. what.  I came up with this idea back when I first wrote the ZModem code for
  352. Opus, and cleared it for future compatibility with ZModem's designer, Chuck
  353. Forsberg, back then.  Since then the basic concept has been extensively
  354. tested in the Opus BBS system, and has proven quite effective; it has also
  355. been incorporated into various other ZModem implementations over time.  The
  356. actual algorithm for deciding what size packets to use when is pretty much
  357. up to the protocol author; XPRZModem uses a modified version of the Opus
  358. algorithm which prevents locking the packet size at a small value when a
  359. large one-time burst of errors occurs.
  360.  
  361.  
  362.  
  363. 7.  Notes for comm program authors
  364. ----------------------------------
  365.  
  366.      That's pretty much everything you need to know in order to use
  367. XPRZModem properly.  Here are some notes for the "other" XPR standard
  368. users, namely the comm program authors:
  369.  
  370.      Certain XPR callback functions *must* be implemented by the comm
  371. program author in order for XPRZModem to be used.  If any of these
  372. functions are not supported by your comm program, XPRZModem will display an
  373. error message and abort when invoked.  These required functions are:
  374.  
  375.           xpr_fopen(), xpr_fclose(), xpr_fread(), xpr_fwrite(),
  376.           xpr_fseek(), xpr_sread(), xpr_swrite(), and xpr_update()
  377.  
  378.      The xpr_update() function provides many data fields for your comm
  379. program to potentially display to the user.  These are the XPR_UPDATE
  380. struct elements which XPRZModem will keep updated during transfers:
  381.  
  382.           xpru_protocol, xpru_filename, xpru_filesize, xpru_msg,
  383.           xpru_errormsg, xpru_blocks, xpru_blocksize, xpru_bytes,
  384.           xpru_errors, xpru_timeouts, xpru_blockcheck, xpru_expecttime,
  385.           xpru_elapsedtime, and xpru_datarate
  386.  
  387.      As you can see, XPRZModem tries to provide as many status fields as
  388. possible.  Although all of them are useful, the ones which are most
  389. important to ZModem users are filename, filesize, msg and/or errormsg, and
  390. bytes.  Please try to provide at least these fields in your status display,
  391. plus as many of the rest as you can manage.
  392.  
  393.      Although only the XPR callback functions listed above are crucial for
  394. XPRZModem, almost all of them are used if they are provided.  Although
  395. XPRZModem will function without any of the other routines, its performance
  396. or capabilities may be degraded somewhat.  Specifically, this is what you
  397. give up if you choose not to supply any of these other XPR callback
  398. functions:
  399.  
  400.           xpr_sflush(): Used when performing error recovery and resync
  401.                when sending files.  If not provided, extra timeout errors
  402.                and delayed error recovery will be likely.  The files will
  403.                still be transferred properly, but errors will degrade
  404.                overall throughput more than usual.
  405.  
  406.           xpr_chkabort(): Called between sending or receiving packets.
  407.                If not provided, there's no way for your comm program user
  408.                to abort a transfer in progress except by trying to somehow
  409.                force it to decide to give up and abort on its own, such as
  410.                by turning off the modem and hoping the protocol will abort
  411.                after enough timeouts (it will, eventually...).
  412.  
  413.            xpr_gets(): Called to prompt the user interactively for options
  414.                when your comm program invokes XProtocolSetup() with a null
  415.                xpr_filename field (if xpr_options() isn't available
  416.                instead).  If not provided, you'll have to prompt
  417.                the user for the options string yourself, and pass this
  418.                string in xpr_filename when invoking XProtocolSetup().
  419.  
  420.            xpr_setserial(): Called to obtain the current serial port
  421.                settings, and to change the serial port to 8N1 if it's not
  422.                already set that way.  If not provided, XPRZModem will
  423.                assume all transfers are being done at 2400 bps, which
  424.                won't hurt anything, and your users will have to make sure
  425.                that the serial port is set to 8N1 themselves.
  426.  
  427.            xpr_ffirst() and xpr_fnext(): If either of these routines are
  428.                missing, XPRZModem will lose the ability to send multiple
  429.                files in a batch.  The xpr_filename pointer passed to
  430.                XProtocolSend() will be assumed to point to the actual full
  431.                filename of the single file to be sent in this batch.  If
  432.                both of these routines are provided, XPRZModem will rely
  433.                upon them completely to obtain the names of the files to
  434.                send, and the xpr_filename pointer will not be used for any
  435.                purpose by XPRZModem except to be passed to ffirst/fnext.
  436.                This gives your comm program a way to send not just a single
  437.                filename template's worth of files in a batch, but a list of
  438.                different filenames.  If, for example, you set xpr_filename
  439.                to point to the first node of a linked list of filenames
  440.                and/or templates to be sent, rather than just having it
  441.                point to a string, you can have your ffirst and fnext
  442.                routines traverse this linked list in order to determine the
  443.                next file to be sent.  Or you could have xpr_filename point
  444.                to a buffer containing a list of filenames separated by
  445.                commas, and your ffirst/fnext routines could return each
  446.                filename in this list in turn.  The key here is that if you
  447.                provide these two routines, you're in complete control over
  448.                the series of names fed to XProtocolSend.  If you omit these
  449.                routines, XPRZModem is stuck with single-file mode.  Once
  450.                again, if these two routines are provided, XPRZModem will
  451.                *always* call them; it makes no attempt to use the
  452.                xpr_filename pointer for anything itself.  This is not
  453.                explicitly spelled out in the XPR standard, but it seems the
  454.                only reasonable way to handle batch protocols to me.
  455.                Hopefully other XPR library authors will follow this
  456.                precedent as well, so that comm program authors will be able
  457.                to count on multiple-filename batch sessions being handled
  458.                properly.
  459.  
  460.            xpr_finfo(): Used to determine the filesize of files being sent,
  461.                in order to tell the receiving system how big they are.
  462.                Also used to determine the size of a file which already
  463.                exists when in Overwrite Resume mode; XPRZModem must be able
  464.                to get the size of the current portion of the file in order
  465.                to be able to tell the sender where to resume sending from.
  466.                If this routine isn't provided, Overwrite Resume mode is
  467.                not allowed.  This routine is also used to check if Text
  468.                mode should be set to Y or N for each file when option TC
  469.                is set.
  470.                
  471.            xpr_options(): If you don't supply this, users will be stuck
  472.                with setting the library options via the semi-cryptic text
  473.                string method (ENV: and/or xpr_gets()).  This routine and
  474.                xpr_update() have a lot to do with the look and feel of your
  475.                program when using XPR libraries; any skimping on these two
  476.                routines will be painfully obvious to the user.  Conversely,
  477.                doing a nice job on these two routines will really make your
  478.                program shine.
  479.  
  480.            xpr_unlink(): Required by the DY and KN options, so if you don't
  481.                supply it, those options are not allowed.
  482.  
  483.  
  484.  
  485. 8.  The future
  486. --------------
  487.  
  488.      I don't want or expect this to be the last or only XPR ZModem library
  489. available.  There are a lot of less-commonly-used ZModem features which
  490. have popped up over the past few years, and many people might like to see
  491. some of them made available.  Such as 32-bit CRC (although I consider
  492. CRC-16 perfectly adequate for the max 1K packets sent by ZModem), full
  493. control-character escaping, or maybe 8th bit escaping to allow use of 7-bit
  494. serial channels.  I didn't want to add a bunch of rarely-used bells and
  495. whistles to this version of the library, because I want it to be able to
  496. serve as comprehensible example code.  I just want to provide a good solid
  497. ZModem which reliably handles the majority of people's needs.  Hopefully,
  498. this will serve as a foundation for future enhanced versions, while
  499. providing a safe fallback for people to come back to if that fancy new
  500. enhanced version (with neo-maxi zoomed weebies) turns out to need some more
  501. debugging.
  502.    
  503.      Bug reports, questions, or comments may be sent to me at:
  504.  
  505.           BIX: rahuebner
  506.           Compu$erve: 73105,1022
  507.  
  508.      Or, if you think it's important, and you want an answer in less than a
  509. week or two, call my BBS:
  510.  
  511.           The Wind Dragon Inn
  512.           1-402-291-8053, 300-9600+ bps, HST/V.32/V.42
  513.        or 1-402-291-3636, 300-2400 bps
  514.  
  515.      I check the messages on my BBS fairly often, so that's where to
  516. get ahold of me quick.  I'll also try and stock the latest XPR standard
  517. spec and XPR libraries there.
  518.  
  519. |---
  520. |    Any comments about the version 2.50 to 2.52 update code may be
  521. |    directed to me, William M. Perkins on BIX, with mail sent to
  522. |     wmperkins.
  523. |--- 
  524.  
  525.  
  526. 9.  The past (revision history)
  527. -------------------------------
  528. 1.0, 29 July 89:  Original release.
  529.  
  530.  
  531.  
  532. 1.1, 3 August 89:  Fixed zsdata() to send file data packet in one swrite()
  533. call instead of calling zsendline for every byte, to prevent hammering the
  534. serial.device with single-byte write requests during uploads, and to speed
  535. up effective data transmission rates.
  536.  
  537.  
  538.  
  539. 2.0, 28 October 89:  Converted from Manx to Lattice C 5.04.  Created
  540. prototypes and made other tweaks as required.  Designed new library skeleton
  541. for Lattice code, replacing the old Manx library skeleton.  Added new
  542. options TC, A, D, K, S, R, and P.  Added support for xpr_options() callback
  543. routine, and generally brought things up to par with XPR Spec 2.0.
  544.  
  545.  
  546.  
  547. 2.10, 12 February 91: Fixed the following generally minor problems:
  548.  
  549.   No longer munges A6 register (this was potentially serious), and added
  550. callback glue to ensure comm program can't munge OUR registers either.
  551. Decided that the protective glue was much safer than the more elegant direct
  552. invocation used in version 2.0.
  553.  
  554.   Slightly less transmission overhead (concatenates all output into single
  555. swrites, builds output packets a bit faster).
  556.  
  557.   Considerably less receive overhead; does a lot more waiting and a lot
  558. fewer sreads, especially at high speed.  WARNING: this change doesn't work
  559. with VLT version 4.846 or earlier (yes, Willy; it really was broken B-)).
  560. This change may or may not actually do you any good, depending upon how
  561. your comm program implements the xpr_sread() function.
  562.  
  563.   Fixed problems getting synchronized with some systems on uploads.
  564.  
  565.   No longer closes files twice.
  566.  
  567.   Now uses fully-reentrant sprintf() from amiga.lib; no more nasty BSS.
  568.  
  569.   A couple of obscure error messages were > 50 bytes long, causing problems
  570. with some comm program's transfer status windows, e.g. the infamouse VLT
  571. "Incredible Shrinking Status Window."
  572.  
  573.   Stabilized spastic data rate by computing elapsed time more accurately.
  574.  
  575.   Fixed sprintf() error which caused invalid filelength to be sent on uploads.
  576.  
  577.   Aligned all data for optimal performance on 68030++ CPUs (now that I have
  578. my A3000... B-)).  Doesn't really make any noticeable difference, but it
  579. makes us 68030 owners feel better anyway.  I'm also including a version of
  580. the library compiled for the 68020+ CPU, on the same principle.
  581.  
  582.   Now uses .DUP2 instead of .DUP.DUP, etc.
  583.  
  584.   Added config option E for number of errors which cause an abort.
  585.  
  586.   Fixed bogus IO_Torture false alarm concerning timer.device.
  587.  
  588.   Tried to fix an elusive Enforcer hit on reading location 0, but I'm not
  589. sure I really got it, since I had trouble reproducing the problem.
  590.  
  591. |---
  592. |    2.52 version, 6 March 1992: Recompile code for 68020 library code.
  593. |    Non-68020 code worked fine but John Tillema was not able to test
  594. |    the 2.51 68020 version.
  595. |
  596. |    2.51 version, 29 January 1992: Rxtimeout changed from 600 to 300
  597. |    for upload timeout problem by John Tillema.
  598. |
  599. |    2.50 version, 15 November 1991:  Added code to support 32 bit CRC
  600. |    (Circular Redundency Check).  CRC-32 adds a little more protection
  601. |    to the data being sent and received than does CRC-16.  Source for
  602. |    the CRC-32 additions came from the Unix version of RZ/SZ by Chuck
  603. |    Forsberg.
  604. |
  605. |    Added code to update_rate() function in utils.c to avoid the
  606. |    Guru # 80000005 if you decide to adjust the system clock during an 
  607. |    upload or download from Daylight Saving Time to Standard Time.  :-)
  608. |
  609. |    Proto additions using libinit.o and libent.o, and eliminating all
  610. |    of the assembler code was supplied by Jim Cooper of SAS.  Jim
  611. |    also supplied the mysprintf() code to replace sprintf().  This
  612. |    version of XprZmodem can be compiled with the SAS version 5.10 C 
  613. |    Compiler.  I do not know how well it might compile with the Aztec
  614. |    compiler.
  615. |
  616. |    THINGS TO DO
  617. |
  618. |    - Preserve date of file being transfered.
  619. |
  620. |    - Investigate possibility of saving file protection bits.
  621. |
  622. |    - Work out ways to increase the transfer speed.
  623. |
  624. |    - Additional changes as time and others may suggest.  :-)
  625. |
  626. |    -WMP-
  627. |---
  628.