home *** CD-ROM | disk | FTP | other *** search
/ Current Shareware 1994 January / SHAR194.ISO / modem / digibord.zip / ZSX201.ZIP / README.ZSX < prev    next >
Text File  |  1991-06-24  |  9KB  |  207 lines
  1.  
  2.                  ZSX v2.00 - a general purpose protocol driver
  3.              (C) 1990, 1991 by Jan R. Terpstra (FIDO 2:512/10.0)
  4.  
  5.  
  6.   WHAT IS ZSX
  7.   ===========
  8.   ZSX is a general purpose protocol driver for Bulletin Board Systems. It
  9.   features SEAlink (with overdrive), Xmodem, Ymodem, Ymodem-Batch, Ymodem-G
  10.   and Zmodem protocols and requires only 55KB free RAM to run.
  11.  
  12.   ZSX requires a FOSSIL driver like OPUS!COMM, x00 or BNU to drive the
  13.   communication port. With x00 and BNU, up to 8 ports are supported.
  14.   NOTE: When using x00, use version 1.23j or later.
  15.  
  16.   ZSX is a protocol driver for Bulletin Board systems, NOT a universal file
  17.   transfer program like DSZ, PCKERMIT, JMODEM, SuperK or Lynx. Compared to
  18.   other (tm) programs, DSZ is slightly crippled:
  19.  
  20.    - Zmodem receive has no crash-recovery. This prevents files on your BBS
  21.      from being overwritten or changed by a user.  Zmodem send does support
  22.      recovery so aborted downloads from your BBS can be picked up at the point
  23.      where they aborted.
  24.    - NAK, CANcel and Carrier drop are ignored for the last block of a download.
  25.      This is to prevent the nasty users to evade the up/download counter of
  26.      your BBS. The bozos do so by aborting the download between the last block
  27.      of the file and the subsequent NAK/ACK sequence on the EOT signal. That
  28.      trick won't work with ZSX!
  29.    - During Zmodem, Ymodem and SEAlink receive, one can optionally refuse any
  30.      additional files to prevent existing files from being overwritten.
  31.  
  32.  
  33.   Running ZSX
  34.   ===========
  35.   To run ZSX, type ZSX followed by one or more of these options:
  36.  
  37.   port N speed N <D d e f o y Z> [list <file>] [log <file>] <cmd> <[@]file>
  38.  
  39.   NOTE: Options are case sensitive!!!!
  40.  
  41.     port        communications port to be used. Can be 1....8, defaults to
  42.                 com 1. When ZSX is used with OPUS!COM, only 2 ports are
  43.                 supported.
  44.  
  45.     speed       linespeed. Can be 300....38400, defaults to 2400.
  46.  
  47.     D           (upper case D) Drop DTR when carrier is lost. Some BBS
  48.                 programs act a little odd when an external protocol does not
  49.                 reset the modem on carrier loss.
  50.  
  51.     d           (lower case d) Disable carrier monitor. Comes in handy when
  52.                 sending files over a null-modem.
  53.  
  54.     e           Escape all control characters for Zmodem. This slows down
  55.                 transfer by up to 50%, but it allows Zmodem transfer over
  56.                 non-transparent networks
  57.  
  58.     L           Length overrride for Zmodem send blocks (32.....1024).
  59.  
  60.     r           Be forgiving for Xmodem, Ymodem and SEAlink timing. Usefull if
  61.                 transferring files over a satellite link ("relaxed" timing).
  62.  
  63.     o           Run SEAlink in Overdrive mode.
  64.  
  65.     y           Allow receive to overwrite existing files.
  66.  
  67.     Z           Use Zmodem RLE compression. Option is disabled automatically
  68.                 when transferring ARC, ARJ, DWC, GIF, LZH, PAK, ZIP and ZOO
  69.                 files, since those files are already compressed.
  70.  
  71.     log         Filename to log succeeded or failed transfers to. The logfile
  72.                 is compatible with DSZ's log file. ZSX will recognize the
  73.                 "DSZLOG=" environment variable.
  74.  
  75.     list        Filename where the names and sizes of received files are stored
  76.                 when receiving multiple files. This file can later used by the
  77.                 BBS program to prompt the user to enter the descriptions of the
  78.                 uploaded files.
  79.  
  80.     cmd:        sz = ZMODEM send file(s)
  81.                 ss = SEAlink send file(s)
  82.                 sb = Ymodem-Batch (True-Ymodem) send file(s)
  83.                 sy = Ymodem (Xmodem-1K) send file
  84.                 sg = Ymodem-G send file
  85.                 sx = Xmodem send file
  86.                 rz = Zmodem receive file(s)
  87.                 rs = SEAlink receive file(s)
  88.                 rb = Ymodem-Batch (True-Ymodem) receive file(s)
  89.                 ry = Ymodem (Xmodem-1K) receive file
  90.                 rg = Ymodem-G receive file
  91.                 rx = Xmodem receive file
  92.  
  93.     file        filename to be send/received.
  94.  
  95.     @file       Name of the response file that lists the files to be send in
  96.                 one batch.
  97.  
  98.  
  99.   SOME EXAMPLES
  100.   =============
  101.   ZSX port 1 speed 2400 Z rz C:\MYFILES\AAA.BBB
  102.    receive Zmodem/Compressed file AAA.BBB to subdir C:\MYFILES via port 1
  103.    at 2400 bps Only AAA.BBB will be received, additional file(s) will be
  104.    refused.
  105.  
  106.   ZSX port 1 speed 9600 o ss @FIL.LST
  107.    send Sealink-Overdrive files listed in FIL.LST via port 1 at 9600 bps
  108.  
  109.   ZSX port 2 speed 9600 rb C:\FILES\
  110.    receive Ymodem-Batch via port 2 at 9600 bps. Received file(s) will be
  111.    written to subdir C:\FILES\
  112.  
  113.   ZSX port 8 speed 300 rx C:\FILES\FILE.NEW
  114.    receive Xmodem FILE.NEW into subdir C:\FILES\ via port 8 at 300 bps
  115.  
  116.   ZSX port 5 speed 38400 list UPLOADED.LST d y rz C:\FILES\
  117.    receive Zmodem via port 5 at 38400 bps. Omit carrier check. Received
  118.    file(s) will be written to subdir C:\FILES\ and existing file(s) will
  119.    be overwritten. Names and filesizes of received files will be written
  120.    to list-file UPLOADED.LST.
  121.  
  122.   ZSX port 2 speed 19200 o sg *.*
  123.    send all files in the current directory using Ymodem-G via port 2 at
  124.    19200 bps.
  125.  
  126.   ZSX port 1 speed 2400 sx C:\FILES\*.*
  127.    Send all files in the current directory using Xmodem via port 2 at 2400 bps.
  128.    Because Xmodem and Ymodem (rather, Xmodem-1K) are not batch protocols, ZSX
  129.    will send the name of the file about to be sent as a readable string to the
  130.    receiver's end, right before the file is transmitted.
  131.  
  132.   Notice: ZSX reports the relative throughput at the end of the transfer.
  133.   Contrary to other popular transfer utiltities, ZSX reports the ACTUAL
  134.   efficiency, including the protocol's overhead (init handshake, header
  135.   block transfer and EOF handshake). Thus the relative througput reported
  136.   will be slightly less (but more honest) when compared to other protocol
  137.   drivers.
  138.   Because the granularity of the throughput timer is 1 second, transferring
  139.   small files (i.e. less then about 30 seconds) may report an efficiency of
  140.   over 100% or an efficiency that seems way to low.
  141.  
  142.  
  143.   COPYRIGHTS AND SUCH
  144.   ===================
  145.   Apart from the rights on those parts of the code by Omen Tech and System
  146.   Enhancement Associates, this program is free of idiosyncratic license
  147.   requirements. You may use this program in a non-commercial environment in
  148.   whatever way you like. You may use it as a doorstop or feed it to your dog.
  149.  
  150.   Use in a commercial environment may require you to enter a license agreement
  151.   with either Omen Tech or System enhancement Associates. I don't want to get
  152.   involved in all sorts of legal discussions, so ask them and don't you dare
  153.   to bug me about it!!!!!
  154.  
  155.   However, a simple registration of this product is required! Register by
  156.   sending a postcard to:
  157.     J.R. Terpstra
  158.     P.O.Box 66
  159.     1462 ZH  Beemster
  160.     The Netherlands
  161.  
  162.   Registration won't buy you anything and you're not entitled to anything
  163.   special when registering this program. I just happen to like postcards.
  164.  
  165.  
  166.   RELEASE NOTES
  167.   =============
  168.   June 24, 1991 - v2.01
  169.   Fixed a minor bug in carrier detect of Zmodem routines
  170.  
  171.   June 16, 1990 - v2.00
  172.   Added Zmodem/Compressed (RLE compression) and Zmodem variable headers.
  173.   Changed all CRC routines to assembler.
  174.   Changed logging, ZSX now writes a DSZ style logfile.
  175.   Bugs fixed:
  176.   - SEAlink/Overdrive timeout problem.
  177.   - Zmodem receive failure on last block.
  178.  
  179.   December 1, 1990 - v1.70
  180.   After several beta-test releases, version 1.70 is now released to the
  181.   general public. The documentation is a bit sparse and the program needs
  182.   some minor cosmetic fixes, but the program is functional.
  183.  
  184.  
  185.   KUDOS
  186.   =====
  187.   ZSX was based on (and contains parts of) Chuck Forsberg's Zmodem routines
  188.   and SEAlink routines by Thom Henderson. Some of the ideas in this program
  189.   were blatantly stolen from Opus' Zmodem download driver and BinkleyTerm.
  190.   You have to thank the original authors for whatever quality is present in
  191.   this program. I merely glued the existing pieces together as a learning
  192.   project and to sink my teeth in some C code.
  193.  
  194.   Many thanks to Doug Azzarito for scrutinizing the code. Also my thanks to
  195.   Heiko Rommelman for sending me the Proficient C book, which was the main
  196.   reason for me to start programming in C. Though my wife didn't understand
  197.   why I wanted to learn yet another programming language, I think it was
  198.   worth doing it :-)
  199.  
  200.  
  201.   "Backward? Yes. Compatible? Dunno."
  202.  
  203.  
  204.                                                 <JT>
  205.  
  206.  
  207.