home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / DEMO510.ZIP / SLZMODEM.INS / ZMODEM.DOC next >
Text File  |  1999-01-25  |  10KB  |  243 lines
  1.  
  2. ZMODEM.EXE: External Zmodem file transfer protocol for Searchlight BBS
  3.             Version 4.0, May 1994
  4.  
  5. Introduction
  6. ------------
  7. ZMODEM.EXE is an external file transfer protocol driver for Searchlight BBS. 
  8. Like the popular DSZ utility, this program can be used as an external 
  9. protocol from Searchlight BBS, or it can be called from batch files or other 
  10. programs, providing a flexible Zmodem engine for use while running doors in 
  11. the Searchlight BBS environment.  
  12.  
  13. Searchlight's ZMODEM driver is optimized for the Searchlight BBS 
  14. environment. Unlike DSZ, Searchlight's Zmodem driver:
  15.  
  16.   o  Uses any COM port that Searchlight supports, including FOSSIL driven
  17.      ports and DigiBoard ports.
  18.  
  19.   o  Reads communications parameters directly from the SLBBS CONFIG file,
  20.      and therefore requires no complex command line arguments.
  21.  
  22.   o  Cooperates with DESQview, Windows or OS/2, consuming less CPU time than
  23.      DSZ, especially at lower baud rates.
  24.  
  25.   o  Automatically disables (and re-enables) Searchlight's standard door
  26.      communications support if active. You can run ZMODEM.EXE freely in any
  27.      Searchlight door, regardless of the Communications Support setting.
  28.      You can even type ZMODEM commands from a remote DOS prompt.
  29.  
  30. ZMODEM.EXE implements the full Zmodem protocol including variable block 
  31. length, CRC-32 or CRC-16 error checking, and high speed streaming send and 
  32. receive capability. Standard Xmodem Checksum, Xmodem/CRC, and Xmodem 1K file 
  33. transfers are also supported. An informative display window shows file 
  34. transfer progress complete with running bar graphs and CPS count.
  35.  
  36.  
  37. Syntax
  38. ------
  39. The command line syntax for ZMODEM.EXE is:
  40.  
  41.   ZMODEM [-Sn|-Rn] [-P<Path>] [-C] [Filename...] [@Filename]
  42.  
  43.   "Sn" is one of the following:
  44.      -S or -SZ: Zmodem send
  45.      -SX: Checksum Xmodem send
  46.      -SC: CRC Xmodem send
  47.      -SK: 1K (large block) Xmodem send
  48.  
  49.   "Rn" is one of the following:
  50.      -R or -RZ: Zmodem receive
  51.      -RX: Checksum Xmodem receive
  52.      -RC: CRC Xmodem receive
  53.      -RK: 1K (large block) Xmodem receive
  54.  
  55.  
  56. Send Files
  57. ----------
  58. With Zmodem send commands, you can specify a list of files in one of two 
  59. ways: either by typing the files explicitly on the command line, or by 
  60. typing the @ character followed immediately by a filename that contains a 
  61. list of the desired files in plain text format (the same kind of list 
  62. Searchlight BBS generates when using an external protocol). You can use both 
  63. explicit filenames and indirect files on the same command line if desired. 
  64. The maximum number of files that may be downloaded with one command is 60. 
  65. Full pathnames and wildcards are supported.  
  66.  
  67. Xmodem commands can send only 1 file at a time. Any additional filenames 
  68. specified are ignored.  
  69.  
  70.  
  71. Receive Files
  72. -------------
  73. With the receive zmodem (-R or -RZ) command, you have the following options:
  74.  
  75.   o  If no filenames are specified on the command line, ZMODEM receives any 
  76.      number of incoming files, which are stored in the current directory.  
  77.  
  78.   o  If a directory path (ending with a backslash) is specified, ZMODEM
  79.      receives any number of files, which are stored in the given directory.
  80.  
  81.   o  If a single filename is given on the command line, ZMODEM receives data 
  82.      to the specified file only, regardless of the incoming filename. Only 
  83.      one file is received; if the sender attempts to send multiple files, 
  84.      the remaining files are skipped.  
  85.  
  86. For Xmodem receive commands, you must specify a single filename on the 
  87. command line (which may include a path if desired). Only one file can be 
  88. received at a time with Xmodem.
  89.  
  90. If the transfer is aborted during a file receive, the incomplete file is 
  91. always deleted.
  92.  
  93.  
  94. CONFIG Path
  95. -----------
  96. ZMODEM must open your Searchlight CONFIG.SL2 file in order to automatically 
  97. initialize the correct baud rate and serial port. If the CONFIG.SL2 file is
  98. in the current directory, or if an environment variable "SLBBS" is set to 
  99. the appropriate directory, no further action is needed. If not, you can 
  100. specify the directory where CONFIG.SL2 is located via the -P command line 
  101. parameter. -P should be followed by the correct directory, without any 
  102. intervening spaces (ie. ZMODEM -S -Pc:\slbbs ... ).
  103.  
  104. COM Support Swap
  105. ----------------
  106. A -C switch is provided to disable the ZMODEM program from toggling 
  107. Searchlight's BIOS communications support. This switch is provided ONLY for
  108. cases where ZMODEM.EXE is executed from another program which has already 
  109. swapped COM support. DO NOT use this switch unless instructed to do so by
  110. another program's documentation.
  111.  
  112.  
  113. Return Codes
  114. ------------
  115. ZMODEM.EXE returns 0 for success, or 1 for failure. Failure can occur for 
  116. any of the following reasons:
  117.  
  118.   o  Searchlight BBS is not loaded, or the CONFIG.SL2 file is not found.
  119.  
  120.   o  Insufficient or incorrect command line parameters are specified.
  121.  
  122.   o  The file transfer fails or is cancelled. Cancellation can occur by 
  123.      pressing ESC locally or by signal from the remote end. Failure can 
  124.      occur for a variety of reasons, including bad filenames specified with 
  125.      the send command, excessive errors or retries, or disk full.  
  126.  
  127. If a Zmodem send command returns an error level of 1, it indicates that not 
  128. all of the files were successfully transferred. Some files may have been 
  129. sent successfully. Similarly, failure with a Zmodem receive command does not 
  130. imply that no files were received successfully, only that at least one file 
  131. was aborted (the incomplete file is always deleted).  
  132.  
  133.  
  134. Examples
  135. --------
  136. Below are some examples using ZMODEM.EXE to transfer files. These examples 
  137. can be used in batch files that run as doors from Searchlight BBS, from door 
  138. programs that shell out to an external program, or even directly from the 
  139. command line if you are logged in remotely and are using a remote DOS shell 
  140. door. Do not run ZMODEM commands locally.
  141.  
  142. ZMODEM -S MYFILE.ZIP
  143.   This command sends the file, MYFILE.ZIP, using Zmodem protocol.
  144.  
  145. ZMODEM -S THISFILE.ZIP THATFILE.ZIP MYFILE.ZIP
  146.   This command sends the three files specified via Zmodem.
  147.  
  148. ZMODEM -S -Pc:\slbbs MYFILE.ZIP
  149.   Sends MYFILE.ZIP. The -P parameter forces ZMODEM to look for the CONFIG.SL2
  150.   file in the directory "c:\slbbs".
  151.  
  152. ZMODEM -S @LIST.TXT
  153.   Sends all the files listed in the text file LIST.TXT (Zmodem protocol).
  154.  
  155. ZMODEM -R
  156.   Receives any number of files to the current directory via Zmodem.
  157.  
  158. ZMODEM -R c:\slbbs\temp\
  159.   Receives any number of files to the directory "C:\SLBBS\TEMP".
  160.  
  161. ZMODEM -R FILE.ZIP
  162.   Receives the file FILE.ZIP to the current directory. Note that ONLY one
  163.   file, named FILE.ZIP, will be created, regardless of how many files the
  164.   sender attempts to send or what the actual filename is.
  165.  
  166. ZMODEM -SX MYFILE.ZIP
  167.   Sends MYFILE.ZIP via Xmodem Checksum protocol.
  168.  
  169. ZMODEM -SK MYFILE.ZIP
  170.   Sends MYFILE.ZIP via 1K Xmodem protocol.
  171.  
  172. ZMODEM -RC THISFILE.ZIP
  173.   Receives the file THISFILE.ZIP via Xmodem/CRC.
  174.  
  175. Note: the Xmodem protocols are somewhat dynamic in the sense that the other 
  176. side can sometimes override the default block check or block size specified 
  177. on the command line. Therefore the block size or CRC/Checksum method 
  178. displayed during the transfer may not be the same as what was entered on the
  179. command line.
  180.  
  181.  
  182. Installation
  183. ------------
  184. Below is an example of using ZMODEM.EXE to implement Zmodem as an external
  185. protocol in Searchlight BBS. These examples assume that the ZMODEM.EXE 
  186. program is located in the root directory of drive C:, and the Searchlight 
  187. home directory is in C:\SLBBS:
  188.  
  189.   1. Protocol Name ................ Zmodem
  190.   2. Protocol Send Command ........ c:\zmodem.exe -s -pc:\slbbs @file.lst
  191.   3. Protocol Receive Command ..... c:\zmodem.exe -r -pc:\slbbs
  192.  
  193. If you use a home directory other than C:\SLBBS, or if your ZMODEM.EXE file 
  194. resides in another location, change the above examples as appropriate. 
  195. '@FILE.LST' may be shortened to any filename if required.
  196.  
  197. Complete instructions for installation of External Protocols is located in 
  198. your Searchlight manual. Please refer to it for background information.
  199.  
  200.  
  201. Notes
  202. -----
  203. ZMODEM.EXE depends on the memory resident Searchlight BBS communications 
  204. drivers. Therefore, it will run only as a door or external protocol from 
  205. Searchlight BBS, and will not function if run while SLBBS is not loaded.
  206.  
  207. ZMODEM.EXE uses either BIOS or direct screen writes to display its status 
  208. screen, depending on how Searchlight is configured. It returns the display 
  209. to its previous contents before exiting. ZMODEM.EXE displays no other 
  210. headings or messages during its operation, unless there is a failure to 
  211. initialize and read the CONFIG.SL2 file or insufficient command line 
  212. parameters.  
  213.  
  214. If you run a multinode Searchlight BBS, be sure that ZMODEM.EXE opens the 
  215. correct CONFIG.SL2 file for the node from which the door or protocol is 
  216. launched. The easiest way to do this is to set the environment variable 
  217. SLBBS=<directory>. Make sure this parameter is different for each node in 
  218. your system; for example, in a DESQview environment, use SET SLBBS= in each 
  219. window by running a batch file when the window is opened, rather than in 
  220. your autoexec.bat file.
  221.  
  222.  
  223. Searchlight 2.xx
  224. ----------------
  225. A replacement version of SLBBS.EXE may be included with this program. The 
  226. replacement makes some additional low-level async functions available to the 
  227. Zmodem drivers. Install the new SLBBS.EXE program by copying it over your 
  228. existing program. Installation of the updated SLBBS.EXE file is REQUIRED if 
  229. you are running version 2.25C or earlier, and is optional (but recommended) 
  230. if you are running Searchlight 2.25D or 3.0/WL. 
  231.  
  232. DO NOT install this new driver if you are using a Searchlight 3.0 version 
  233. with a 1993 or later release date. (You will not receive the driver if you
  234. installed this program from a Searchlight 3.0 distribution disk).
  235.  
  236.  
  237. (c) Copyright 1994 Searchlight Software, Inc.
  238.     6516 Detroit Ave, Cleveland OH 44102
  239.     216-631-9290 Voice/Tech support
  240.     216-631-9285 BBS
  241.     800-988-5483 Sales
  242.  
  243.