home *** CD-ROM | disk | FTP | other *** search
/ Current Shareware 1994 January / SHAR194.ISO / modem / xyz2_100.zip / CEXYZ.DOC next >
Text File  |  1993-10-25  |  14KB  |  315 lines
  1.  
  2.                                 CE-XYZ/2 v1.00
  3.                       A File Transfer Protocol Module
  4.            Supporting Xmodem, Ymodem, Zmodem, and their variants
  5.                          For OS/2 v2.00 and higher
  6.  
  7.                 Copyright (C) 1993 by Cutting Edge Computing
  8.                             All Rights Reserved.
  9.  
  10.  
  11. ALSO AVAILABLE
  12. --------------
  13. A DOS version of CE-XYZ is also available.  CEXYZ100.ZIP is available
  14. from FidoNet node 1:2240/176, or by calling the BBS at 1-313-743-8464.
  15.  
  16.  
  17. LICENSE AGREEMENT
  18. -----------------
  19. This program is free for non-commercial use.  Commercial users are granted
  20. a license to use CE-XYZ if, and only if, the user has purchased a license
  21. to use The Blue Wave Offline Mail Door.  Your Blue Wave Offline Mail Door
  22. Registration Certificate is sufficient "proof" of license to use this
  23. protocol module.
  24.  
  25. If you are a commercial user and would like to use this protocol module for
  26. other purposes, please write to the address below with contact information
  27. so that we may negotiate a license fee.
  28.  
  29. Software authors that would like to distribute CE-XYZ in their distribution
  30. packages will be granted a license to do so for a reasonable, one-time
  31. licensing fee.  Please contact me at the address below for more
  32. information.  Special hooks are provided in the developer's edition for
  33. executing CE-XYZ directly from your applications, no matter what programming
  34. language you may be using.  Source code is NOT provided - however any minor
  35. cosmetic/color changes, default settings, and a customized title banner can
  36. be done with no extra fee (other than the licensing/redistribution fee).  All
  37. licensing is done with a one-time flat fee.  There are no "per-copy" or
  38. "royalty" fees involved.
  39.  
  40. Cutting Edge Computing
  41. PO Box 90476
  42. Burton, MI  48509
  43.  
  44. FidoNet : 1:2240/176
  45. InterNet: george.hatchew@f176.n2240.z1.fidonet.org
  46.  
  47.  
  48. WARRANTY
  49. --------
  50. There is no warranty for this software, either expressed or implied.  The
  51. user assumes full responsibility for the use of this software.
  52.  
  53.  
  54. SUPPORT
  55. -------
  56. Because this is a "free for non-commercial use" program, no support will be
  57. given for this program, except in the following cases:
  58.  
  59.   1)  User has also registered one of The Blue Wave Offline Mail Doors,
  60.       produced by Cutting Edge Computing.
  61.  
  62.   2)  To commercial users who have paid the licensing fee to Cutting Edge
  63.       Computing.
  64.  
  65.   3)  BBS authors, after they have paid the one-time licensing fee to
  66.       Cutting Edge Computing.
  67.  
  68. General help with this protocol engine can be obtained through the
  69. International FidoNet BLUEWAVE Echo.  Netmail (except in the above cases)
  70. will not be answered, but bug reports will be worked on.
  71.  
  72.  
  73.  
  74.  
  75. PURPOSE
  76. -------
  77. The purpose of this program is to provide a file transfer protocol module
  78. specifically designed for use with OS/2 v2.0 and higher.  This application
  79. is written for OS/2 text mode, and does not use the Presentation Manager.
  80. It can be used in the place of ANY external protocol module.
  81.  
  82. The file transfer protocol module is excellent for use on BBS systems, as
  83. it provides security against users uploading files to a remote-defined
  84. path on the BBS system.  (The default, and only, mode of batch uploading
  85. is the same as DSZ/GSZ's "restrict" keyword).  Users will not be able to
  86. upload files to any path except for the path that you specify.  Also, the
  87. FTP does not allow the "overwriting" of an existing file.
  88.  
  89.  
  90. DESCRIPTION
  91. -----------
  92. The file transfer protocol (named "CE-XYZ/2", and referred to as the FTP
  93. throughout the rest of the document) currently supports the following
  94. protocols:
  95.  
  96.   - Zmodem with 32-bit CRC   1024 byte subpackets
  97.   - Zmodem with 16-bit CRC   1024 byte subpackets
  98.   - ZedZap with 32-bit CRC   8192 byte subpackets
  99.   - Ymodem-Batch              128 byte blocks (True Ymodem)
  100.   - Ymodem-1K                1024 byte blocks
  101.   - Ymodem-G                 1024 byte blocks
  102.   - Xmodem-1K                1024 byte blocks
  103.   - Xmodem CRC/Checksum (CRC is the default, fallback to Checksum if remote
  104.                          end doesn't seem to like the CRC method)
  105.  
  106. The FTP uses your installed OS/2 Communications driver (COMM.SYS, SIO.SYS)
  107. for communication with the serial port.  We highly recommend the use of Ray
  108. Gwinn's SIO drivers for high-speed modem communications over the drivers
  109. supplied by IBM in the distribution package of OS/2.
  110.  
  111. The FTP is command line driven;  it must be invoked with command line
  112. parameters specifying, at the very least, the "handle" of the active port
  113. and the protocol transfer method.  This protocol driver WILL NOT initialize
  114. and open a communications handle.  An active communications handle must be
  115. passed to CEXYZ/2 for file transfers to take place.
  116.  
  117. In order to accomodate terminal and BBS programs that require the use of
  118. a DSZ-style log file, the FTP will create/append to a DSZLOG-type log file
  119. if the following environment variable is set:
  120.  
  121.   SET CEXYZLOG=cexyz.log
  122.   SET DSZLOG=dsz.log
  123.  
  124. If the CEXYZLOG environment variable is not set, then the driver looks for
  125. the DSZLOG environment variable.  (CEXYZLOG always has precedence over
  126. DSZLOG).  If the DSZLOG environment variable is not set, then no protocol
  127. logging will take place.  The log file generated by CE-XYZ is 100% DSZ
  128. compatible.
  129.  
  130.  
  131. COMMAND LINE PARAMETERS
  132. -----------------------
  133. In order to successfully invoke the FTP, you must use at least the
  134. following command line parameters:
  135.  
  136.   /L or /B to specify either the locked speed or the line speed (or both).
  137.   /R or /S to specify send/receive mode
  138.   /P, to pass CEXYZ/2 the current communications "port" handle.
  139.  
  140. Below is a description of all available command line parameters.  Any
  141. command line parameter that does not start with a / or a - is assumed to
  142. be the file name(s) to send or receive.  More on file name parameters in
  143. the next section.  All command lines are case insensitive (capital
  144. letters and lower-case letters will do the same thing.)
  145.  
  146.  
  147. * EXAMPLE COMMAND LINE PARAMETERS ARE GIVEN AT THE VERY END OF THIS DOCUMENT *
  148.  
  149.  
  150.   /T<number>   -  By default, the FTP places its window and other
  151.                   information beginning on line number 8 of the display in
  152.                   order to "fit into" the window left by BW mail doors.  By
  153.                   using /T<number>, you can tell the FTP to place the first
  154.                   line of the window beginning on a different line.
  155.  
  156.                   /T1 through /T8 are valid.  If <number> is greater than
  157.                   8, 8 is used.  If <number> is less than 1, 1 is used.
  158.  
  159.   /N<1st_last> -  If you pass a User Name to the protocol engine, the name
  160.                   will be displayed on the screen so you know who is online
  161.                   (mainly for BBS usage).
  162.  
  163.                   /NGeorge_Hatchew would display my name on the left-most
  164.                   column of the display screen.  Please note that an
  165.                   underscore between names IS REQUIRED.
  166.  
  167.   /P<number>   -  Specifies the COM port handle to use for the file transfer.
  168.                   If no port is specified, the driver will abort.
  169.  
  170.   /L<number>   -  The LOCKED baud rate of the transfer session, if the serial
  171.                   port should be locked.  High speed modem users should use
  172.                   one of /L19200, /L38400, /L57600, or possibly /L9600.  If
  173.                   you do not specify the locked baud rate, the driver will
  174.                   try to open the port at the rate specified with the /B
  175.                   parameter.  If the /L command line parameter is NOT
  176.                   specified on the command line, CEXYZ/2 will read the
  177.                   current line speed from the serial driver.
  178.  
  179.   /B<number>   -  The actual line speed of the current connection.  If /L
  180.                   is also specified, /B is used for time and CPS
  181.                   estimations ONLY. If you do not have a locked serial
  182.                   port, you should specify the connect rate of modem with
  183.                   /B.  /B300, /B1200, /B2400, /B7200, etc. are some
  184.                   examples.
  185.  
  186.                   The use of the /B command line parameter is not
  187.                   absolutely required if you use a /L command line
  188.                   parameter, but transfer estimations will be wrong if you
  189.                   do not.  The use of /B with /L is much like the
  190.                   "estimate" command in DSZ/GSZ.
  191.  
  192.   /R<protocol> -  Use the /R parameter to receive files via one of the
  193.                   supported protocols.  The following /R switches are
  194.                   supported:
  195.  
  196.                   /Rx    - Receive file with Xmodem-CRC (Checksum fallback)
  197.                   /Rxcrc - Receive file with Xmodem-CRC
  198.                   /Rxchk - Receive file with Xmodem-Checksum
  199.                   /Rx1k  - Receive file with Xmodem-CRC (1024 byte blocks).
  200.                   /Ry    - Receive file(s) with Ymodem-Batch
  201.                   /Ry1k  - Receive file(s) with Ymodem-Batch (1024 byte blks).
  202.                   /Ryg   - Receive file(s) with Ymodem-G
  203.                   /Rz    - Receive file(s) with Zmodem
  204.                   /Rzap  - Receive file(s) with ZedZap (a mutant Zmodem that
  205.                            transfers up to 8K in one subpacket).
  206.  
  207.   /S<protocol> -  Use the /S parameter to send files via one of the
  208.                   supported protocols.  The following /S switches are
  209.                   supported:
  210.  
  211.                   /Sx    - Send file with Xmodem-CRC (Checksum fallback)
  212.                   /Sxcrc - Send file with Xmodem-CRC
  213.                   /Sxchk - Send file with Xmodem-Checksum
  214.                   /Sx1k  - Send file with Xmodem-CRC (1024 byte blocks).
  215.                   /Sy    - Send file(s) with Ymodem-Batch
  216.                   /Sy1k  - Send file(s) with Ymodem-Batch (1024 byte blks).
  217.                   /Syg   - Send file(s) with Ymodem-G
  218.                   /Sz    - Send file(s) with Zmodem
  219.                   /Szap  - Send file(s) with ZedZap
  220.  
  221.  
  222.  
  223.  
  224. Passing File Names to the FTP
  225. -----------------------------
  226. Any command line parameter not preceeded with a "/" or a "-" is assumed
  227. to be the file name to send or receive.
  228.  
  229.  
  230.     SEND Mode
  231.     ---------
  232.     To send files with the FTP, simply enter the name(s) of the files you
  233.     would like to send on the command line, with a full
  234.     drive:\path\filename.exe specification, if the file is not in the
  235.     current directory.  In SEND mode, a file name specification is
  236.     required.
  237.  
  238.     Wildcards (? and *) on the SEND command line are supported.  If the
  239.     requested protocol is a batch protocol (all but Xmodem and Xmodem-1K),
  240.     the FTP will locate all matches to the wildcard specification and then
  241.     begin a batch send.  If the requested protocol is Xmodem or Xmodem-1K,
  242.     only the first directory match to the wildcard specification will be
  243.     sent.  (Xmodem and its variants can only send or receive one file at a
  244.     time).
  245.  
  246.     In addition to wildcards, file LISTS are supported.  Suppose you had a
  247.     straight-ASCII text file containing the following:
  248.  
  249.     --- Contents of FILE.LST ---
  250.     D:\FILES\UPLOAD\ZIPPER.ZIP
  251.     D:\FILES\UPLOAD\FTP.EXE
  252.     E:\CPROG\MYFILE.C
  253.     H:\FD\NODELIST\NODELIST.*
  254.     C:\BWAVE\*.BW
  255.     ----- End of FILE.LST ------
  256.  
  257.     To send all of the files contained in this list, place an "@" symbol in
  258.     front of the list file name, as in:
  259.  
  260.     CEXYZ2.EXE /P10 /B14400 /Sz @FILE.LST
  261.  
  262.     Or, if FILE.LST is not in the current directory, use:
  263.  
  264.     CEXYZ2.EXE /P10 /B14400 /Sz @E:\SOMEWHER\FILE.LST
  265.  
  266.  
  267.     RECEIVE Mode
  268.     ------------
  269.     If the FTP is requested to receive files via one of the batch
  270.     protocols, a file name to receive is NOT required on the command line.
  271.     Files received will be placed in the current directory with the file
  272.     name given by the sending system.
  273.  
  274.     If you would like to place received files in a directory other than the
  275.     current directory in batch protocol mode, simply enter the name of the
  276.     directory on the command line to receive the file(s) to:
  277.  
  278.     CEXYZ2 /P11 /B2400 /Rz E:\Files\Download
  279.  
  280.     If the directory E:\Files\Download exists, the FTP will place the
  281.     received files there.
  282.  
  283.     Supposing you are downloading a file called THISFILE.ZIP via Zmodem,
  284.     and you would like to place it in the directory C:\FILES with the file
  285.     name of MY-DL.ZIP, simply specify the complete file name.  The file
  286.     name received from the sender will be overriden.  Example:
  287.  
  288.     CEXYZ2.EXE /P17 /B1200 /Rz C:\Files\My-DL.Zip
  289.  
  290.     If you are receiving files via Xmodem or Xmodem-1K, a full file name
  291.     specification is REQUIRED on the command line, since these 2 protocols
  292.     do not support the passing of a file name.  Example:
  293.  
  294.     CEXYZ2 /P14 /L38400 /B2400 /Rx E:\Files\Download\Myfile.arj
  295.  
  296.  
  297. EXAMPLE COMMAND LINES
  298. ---------------------
  299. Modem active on port handle 12, locked at 38400 bps, connected at 9600 bps
  300. with a user, receiving a batch upload with Ymodem-G to D:\BBS\FILES\UPLOAD
  301. directory:
  302.  
  303.     CEXYZ2.EXE /l38400 /b9600 /p12 /ryg d:\bbs\files\upload
  304.  
  305. Modem active on port handle 15, no locked port, connected at 1200bps, receiving
  306. a file via Xmodem:
  307.  
  308.     CEXYZ2.EXE /p15 /b1200 /rx filename.ext
  309.  
  310. Modem active on port handle 7, no locked port, connected at 2400bps,
  311. receiving files via Zmodem to the current directory:
  312.  
  313.     CEXYZ2.EXE /b2400 /rz
  314.  
  315.