home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / wps / com / os2you / ftp / os2ftp.doc < prev    next >
Encoding:
Text File  |  1992-09-22  |  4.8 KB  |  150 lines
  1. OS/2 File Transfer Protocol driver 1.3          (c) 1992 by Mikael Wahlgren
  2. ===========================================================================
  3.  
  4. This is an external file transfer protocol driver, designed to supply
  5. other programs with file transfer capabilities.  It is specially
  6. designed with Os2You (OS/2 Remote Access Facility by Mikael Wahlgren)
  7. and the Maximus/2 BBS program in mind.
  8.  
  9. This protocol driver supports the following file transfer protocols:
  10.  
  11. Xmodem/ChSum
  12. Xmodem/CRC
  13. Xmodem-1K
  14. Ymodem (batch)
  15. Ymodem-G (batch)
  16. Zmodem (*)
  17. Kermit (*)
  18.  
  19. (*) The Zmodem file transfer protocol is supported in combination with
  20.     the M2Zmodem file transfer program.  M2ZMODEM.EXE must be available.
  21.  
  22.     The Kermit file transfer protocol is supported in combination with
  23.     the CKermit file transfer program (tested with CK5A179B release).
  24.     CKERMIT.EXE must be available.
  25.  
  26.     These protocols does NOT work with Maximus/2.
  27.  
  28.  
  29.  
  30. Possible return codes (ERRORLEVELs)
  31. ===================================
  32.   ERR_NO_ERROR          = 0
  33.   ERR_OPEN_FILE         = 1
  34.   ERR_INIT_SESS         = 2
  35.   ERR_DISK_READ         = 3
  36.   ERR_DISK_WRITE        = 4
  37.   ERR_COM_READ          = 5
  38.   ERR_COM_WRITE         = 6
  39.   ERR_CANCEL            = 7
  40.   ERR_FATAL_COM         = 8
  41.   ERR_NO_DCD            = 9
  42.   ERR_LOCAL_CANCEL      = 10
  43.   ERR_TIMEOUT           = 255;
  44.  
  45. (these error codes are only valid for Xmodem and Ymodem family protocols.
  46. For return codes of Zmodem and Kermit, see the M2Zmodem and CKermit
  47. documentations)
  48.  
  49.  
  50. Special instructions to run the program with Os2You
  51. ===================================================
  52. This program is especially designed with Os2You in mind.  The recommended
  53. protocol is Ymodem, which is default.  To use this protocol driver with
  54. Os2You, just copy the files into a pathed directory and run the following
  55. commands:
  56.  
  57. Os2FTP -sC:\Files\*.DAT  (to transfer files C:\Files\*.DAT)
  58. Os2FTP -rC:\Download     (to receive files into C:\Download directory)
  59.  
  60. If you want to use another protocol, like YmodemG, the commands will look
  61. like:
  62.  
  63. Os2FTP -YMODEMG -sC:\Files\*.DAT
  64. Os2FTP -YMODEMG -rC:\Download
  65.  
  66.  
  67.  
  68. Instructions on use with BBS
  69. ============================
  70. Copy all of the distributed files into your Maximus home directory.
  71. To interface these protocols with the BBS (Maximus/2) you will have
  72. to add the following lines to your PROTOCOL.CTL file:
  73.  
  74. ------------------------------- cut here -----------------------
  75. Protocol Ymodem
  76.          Type            Batch
  77.  
  78.          LogFile         Ymodem%K.Log
  79.          ControlFile     Ymodem%K.Ctl
  80.          DownloadCmd     OS2FTP.Exe -nosts -s#Ymodem%K.Ctl
  81.          UploadCmd       OS2FTP.Exe -nosts -r#Ymodem%K.Ctl
  82.          DownloadString  Send %s
  83.          UploadString    Get %s
  84.          DownloadKeyword Sent
  85.          UploadKeyword   Got
  86.          FilenameWord    1
  87.          DescriptWord    0
  88. End Protocol
  89.  
  90.  
  91. Protocol G-Ymodem
  92.          Type            Batch
  93.  
  94.          LogFile         YmodG%K.Log
  95.          ControlFile     YmodG%K.Ctl
  96.          DownloadCmd     OS2FTP.Exe -ymodemg -nosts -s#YmodG%K.Ctl
  97.          UploadCmd       OS2FTP.Exe -ymodemg -nosts -r#YmodG%K.Ctl
  98.          DownloadString  Send %s
  99.          UploadString    Get %s
  100.          DownloadKeyword Sent
  101.          UploadKeyword   Got
  102.          FilenameWord    1
  103.          DescriptWord    0
  104. End Protocol
  105.  
  106.  
  107. Protocol M2-Zmodem
  108.          Type            Batch
  109.  
  110.          LogFile         M2Z%K.Log
  111.          ControlFile     M2Z%K.Ctl
  112.          DownloadCmd     OS2FTP.Exe -zmodem -s#M2Z%K.Ctl
  113.          UploadCmd       OS2FTP.Exe -zmodem -r#M2Z%K.Ctl
  114.          DownloadString  Send %s
  115.          UploadString    Get %s
  116.          DownloadKeyword Z-Sent:
  117.          UploadKeyword   Z-Received:
  118.          FilenameWord    1
  119.          DescriptWord    0
  120. End Protocol
  121.  
  122. ------------------------------- cut here -----------------------
  123.  
  124. You should also ensure that the PROTOCOL.CTL file is included in
  125. your MAX.CTL file (i.e. ensure that the MAX.CTL file is ended with
  126. a line like "include PROTOCOL.CTL")
  127.  
  128. The Xmodem protocols should be possible to use in this way as well, but
  129. I can't see the use of this.
  130.  
  131. There is no guarantee that these file transfer protocols work in all
  132. situations.  Especially the Zmodem protocol is untested for this kind
  133. of usage.  I am not legally responsible for any harm that your system
  134. may suffer from, by the use of this program.
  135.  
  136.  
  137.  
  138. Licensing information
  139. =====================
  140. If you haven't registered the Os2You/M2Zmodem/OS2FTP file transfer option,
  141. this program will introduce an intentional delay before transfering any
  142. files.  Note that the Ymodem protocol used in this protocol driver is exactly
  143. the same driver that is built in Os2You, available via the Service functions
  144. menu.
  145.  
  146. To register, use the included order form and specify the
  147. Os2You/M2Zmodem/OS2FTP item.
  148.  
  149. Mikael Wahlgren
  150.