home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 September / Simtel20_Sept92.cdr / msdos / qmodem / hst20.arc / HST20.DOC next >
Text File  |  1989-02-15  |  13KB  |  329 lines
  1. USRobotics Courier HST Qmodem Service Script Production Release 2.0
  2. -------------------------------------------------------------------
  3.  
  4. (c) Copyright Dan Moore, 1987-1989
  5.  
  6. The USRobotics logo, Courier, and HST are trademarks of
  7. USRobotics, Inc.
  8.  
  9. QModem and QModem SST are trademark of John Friel III and the
  10. Forbin Project, Inc.
  11.  
  12. USE RESTRICTION AND DISCLAIMER
  13.  
  14. This script is copyrighted solely to prevent others from reaping
  15. financial gain through its sale and/or use.  Permission has been
  16. given to John Friel III and the Forbin Project, Inc., to
  17. distribute this script as part of the QModem SST program
  18. package, release 4.0 for private use only.
  19.  
  20. The HST20 script and its accompanying files and documentation
  21. may not be distributed as part of any other computer
  22. communication hardware or software package without the written
  23. permission of the author.  This script may be copied and
  24. distributed freely by private individuals who wish to share it
  25. with others as long as no specific charge is assessed for this
  26. service other than minimal fees (not to exceed $5) to cover the
  27. distribution medium.
  28.  
  29. Permission is hereby granted to System Operators of active
  30. Bulletin Boards to post the HST20 archive file for public
  31. distribution.  Due to the easily modifiable nature of QModem
  32. scripts,  modified versions of the script should bear a
  33. different name and have their origin clearly identified.  The
  34. NAME of the script is copyrighted as well as its contents. The
  35. HST20.ARC file or other compressed versions of the HST20.ARC
  36. original may not be modified for any purpose whatsoever.
  37.  
  38.  
  39. COMMERCIAL USES OF THE HST SCRIPT
  40.  
  41. The series of HSTxx Qmodem Scripts may not be used for
  42. marketing, demonstrations, advertising, problem diagnosis or
  43. correction OR FOR ANY COMMERCIAL OR BUSINESS PURPOSES by modem
  44. manufacturers, their agents, dealers, resellers, or any company
  45. or individual involved in the sale, marketing, maintenance, or
  46. business use of modems or other computing devices WITHOUT
  47. A COMMERCIAL LICENSE TO USE THE SCRIPT.  Superficial editing of
  48. the script's code to mask its origin and avoid licensing
  49. costs is a violation of the author's copyright, and will be
  50. pursued to the full extent of the law.
  51.  
  52. To obtain a commercial- or business-use license for the HST
  53. script(s), refer to the LICENSE.DOC file in the HST20 archive.
  54.  
  55.  
  56. HST MODEM DEPENDENCY
  57.  
  58. The HST20 script will operate satisfactorily on USRobotics HST
  59. modems with ROM levels 961, 963, and 964.  To determine the
  60. HST's ROM level, run the HST20 script or type ATI0<Enter> while
  61. in Qmodem terminal mode.
  62.  
  63. If your HST modem is NOT at level 964, I strongly recommend that
  64. you get it upgraded.  The cost if extremely reasonable and the
  65. upgrade is performed quickly by USR.  You will gain MNP levels 4
  66. and 5.  Compared to ROM level 963/961, release 964 will gain you
  67. an additional 100cps for Ymodem/G transfers of binary or
  68. compressed files, and will outright double your effective
  69. transfer speed for uncompressed text files when MNP 5
  70. compression is used.   For details on the HST upgrade program,
  71. call USR Technical Support at 800-982-5151 (in Illinois, call
  72. 312-982-5151).
  73.  
  74.  
  75. QMODEM RELEASE DEPENDENCY
  76.  
  77. The HST20 script will operate with Qmodem 4.0 and later releases
  78. of Qmodem.  This script relies on certain features of the Qmodem
  79. release 4.0 Script Language and it WILL NOT OPERATE under pre-4.0
  80. releases of Qmodem.
  81.  
  82.  
  83. OPERATIONAL SUMMARY
  84.  
  85. HST20.SCR is intended as a configuration and setup help for the
  86. USR HST modem.  Although it facilitates much of the modem's
  87. setup tasks, some knowledge of the HST's operation and
  88. technology is required, as well as a basic understanding of
  89. computer communications.
  90.  
  91. If you are using HST20 to set up your USR Courier HST for use
  92. with  Qmodem 4.0, the QM menu options will perform all firmware
  93. configuration, leaving physical switch changes up to the you
  94. (correct switch settings are displayed as part of the
  95. script's operation).
  96.  
  97. HST20 automatically detects the ROM release level of your modem.
  98. If your USR HST modem is at ROM level 964 (the latest ROM
  99. level at the time of this release), HST20 will allow you
  100. access to a second level of menu via the "AD" main menu option.
  101. This second menu accesses HST features only available in
  102. 964-level modems, such as data compression (MNP level 5),
  103. settings for the new S-register 15, 4800/7200 link rate
  104. settings, and the new modem configuration screen.  Advanced
  105. Functions are NOT supported for ROM releases prior to 964.
  106.  
  107.  
  108. SETTING UP THE HST FOR QMODEM OPERATION
  109.  
  110. It is likely that you will have to change the modem's switches
  111. from their default factory settings to the setup recommended in
  112. the menu's QM option.  Unfortunately, HST20 can't quite "reach
  113. out and touch switches"; you must do this yourself.  The script
  114. makes you aware of this requirement.  
  115.  
  116. Another very important part of the modem setup is the
  117. configuration of QModem itself.  With release 4.0 of Qmodem,
  118. this is done with the Alt-N command (with release 3.1A of
  119. Qmodem, setup was performed with the QINSTALL Program).
  120.  
  121. The QMSETUP.DOC file, included in this ARChive, will help
  122. help you select the proper QModem configuration parameters for
  123. the HST modem.
  124.  
  125. I recommend that you keep your HST manual handy while you
  126. experiment with the script.  Bug reports or suggestions for
  127. changes or improvements should be reported to me on the Qmodem
  128. Conference Echo carried by the InterLink and SmartNet BBS Mail
  129. Networks.   
  130.  
  131.  
  132. FRIENDLY WARNING
  133.  
  134. HST20 can make permanent changes to the modem's internal
  135. configuration.  Once a setting has been changed, writing the
  136. change to Non-Volatile RAM (NRAM) implements the change until
  137. that setting is changed and written to NRAM again.  Changes to
  138. NRAM are maintained even when the modem power is OFF.  If you
  139. have a working set of modem settings and wish to experiment, do
  140. not copy the changes to NRAM.  The next hardware reset or
  141. power-off / power-on sequence will re-establish the last NRAM
  142. settings.  The HSTINTRO.DOC file describing the HST's basic
  143. internal operation is included in this ARChive; you may wish to
  144. review it to gain a better understanding of the modem's
  145. operation.
  146.  
  147.  
  148. MODEM COMMAND FILES
  149.  
  150. New in release 2.0 of the HST script is the support for special
  151. "Modem Command Files", which can be read from disk and sent
  152. directly to your modem.  Modem Command Files are not intended
  153. for the HST novice.  Until you become familiar with the various
  154. modem commands and parameters, as documented in the HST User's
  155. Manual, you may wish to leave this feature alone.
  156.  
  157. INVOKING A COMMAND FILE
  158.  
  159. Modem command files may be invoked from the standard HST20 menu
  160. with the CF option.  You will be prompted for the command file
  161. name ONLY.  Once the command file is executed, the standard
  162. HST20 menu will be re-displayed.
  163.  
  164. If you are using HST20 solely to execute a command file, you can
  165. specify the command file name in response to the "Script
  166. Parameters" prompt.  When this method is used, HST20 terminates
  167. after the last command has been executed.  This feature allows
  168. the use of HST20 as an autoexec script.
  169.  
  170. CREATING COMMAND FILES
  171.  
  172. Modem command files are created with any standard ASCII text
  173. editor or word processing program with the ability to save
  174. standard, unformatted ASCII files (each line in the file must
  175. end with the standard carriage return/line feed characters).
  176. Modem command files (.HSF) must be stored in your Qmodem script
  177. directory, as defined in the Alt-N/D/S setup.  Any filename is
  178. valid, but the .HSF file extension MUST be used.
  179.  
  180. Each line in a .HSF file may contain a VALID HST modem command,
  181. or one of the following HST20-only commands, starting in the
  182. first column:
  183.  
  184.     @PROMPT  HST20 will pause and issue a "Press <Enter> to
  185.                        continue..." prompt.
  186.  
  187.         @CLRSCR  Clear the screen before issuing the next modem 
  188.                  command.
  189.  
  190.     @CMD     Issue the script command in the next line.  See
  191.                  the section on AUTOEXEC and HST20 programming
  192.                  for additional details on this powerful
  193.                  and potentially dangerous command. 
  194.  
  195. The @PROMPT suspends HST20 operation and is used when lengthy
  196. modem responses are displayed, to prevent the modem's output
  197. from scrolling off the screen when the following command is
  198. executed. 
  199.  
  200. The @CLRSCR command is purely cosmetic; its only effect is to
  201. cause the next command to be displayed at the top of the screen.
  202.  
  203. Commands sent to the HST modem may not exceed 40 characters in
  204. length, not including the AT prefix and imbedded spaces.  Make
  205. sure that lines in command files abide by this restriction.
  206. This restriction is imposed by the modem, not the script
  207. language or Qmodem.
  208.  
  209. COMMAND FILE PROCESSING
  210.  
  211. HST20 will send each line in the command file to the modem and
  212. echo it to the screen.  The standard "OK" return code is expected
  213. from the modem in response to each command.  If this return code
  214. is not received within 5 seconds, the script will force a timeout
  215. and will terminate with an appropriate error message. 
  216.  
  217. Following is a sample 4-line command file: (Note: this file  is
  218. included in the HST20 archive under the name TEST20.HSF)
  219.  
  220. ***start of file***
  221. AT&M4&K0
  222. @PROMPT
  223. ATI5
  224. @PROMPT
  225. @CLRSCR
  226. ATI4
  227. @PROMPT
  228. ***end of file***
  229.  
  230. - The first command enables MNP and auto MNP detect, and
  231.   disables MNP level 5 data compression.
  232.  
  233. - The second command causes the script to pause and display the
  234.   "Press <Enter> to continue " prompt following the OK response. 
  235.  
  236. - The third command requests the HST to display NRAM settings. 
  237.  
  238. - The fourth command causes the script to pause and display the
  239.   "Press <Enter> to continue " prompt following the NRAM display. 
  240.  
  241. - The fifth command clears the screen
  242.  
  243. - The sixth command requests the HST to display RAM settings.
  244.  
  245. - The seventh and last command causes the script to pause and
  246.   display the "Press <Enter> to continue " prompt following the
  247.   RAM display.
  248.  
  249.  
  250. THE AUTOEXEC COMMAND FILE AND DYNAMIC HST20 PROGRAMMING
  251.  
  252. If HST20 is called WITHOUT any parameters AND file called
  253. AUTOEXEC.HSF is found in your Qmodem 4.0 script directory, the
  254. file will be loaded and executed automatically, in a manner
  255. similar to the DOS AUTOEXEC.BAT facility.
  256.  
  257. In addition to the AUTOEXEC.HSF facility, the HST20 is
  258. externally  programmable via .HSF command files and the @CMD
  259. keyword, mentioned earlier.
  260.  
  261. When the keyword @CMD is found in a modem command file, the line
  262. which immediately follows will be executed as a SCRIPT command,
  263. rather than as a modem command.  For example, the two lines:
  264.  
  265. @CMD
  266. SETCOMM CJLM
  267.  
  268. when found in a .HSF file, will cause the serial port to be set
  269. to 2400-N-8-1, as instructed by the SETCOMM Qmodem 4.0 script
  270. command.  Any script command which requires WORD operands
  271. (explicitly stated operands not bound by quotes) or no operand
  272. at all can be executed following the @CMD keyword.  One of the
  273. script commands which can be executed in this fashion is SYSTEM,
  274. which actually terminates Qmodem and returns to DOS.  For
  275. example, the following .HSF file will change the HST's NRAM
  276. setup to use a CCITT answer sequence and will also decrease the
  277. remote carrier length requirements in preparation for a call to
  278. Singapore.  It will then invoke a second script called SINGAPORE
  279. which will dial a bulleting board system there and upload a
  280. file.  Once the SINGAPORE script terminates, the normal HST
  281. parameters will be restored and Qmodem will be terminated:
  282.  
  283. ATB1
  284. ATS9=4
  285. @CMD
  286. SCRIPT SINGAPORE
  287. ATB0
  288. ATS9=6
  289. @CMD
  290. SYSTEM Y
  291.  
  292. NOTE: The SINGAPORE script must terminate with a RETURN command
  293. rather than an EXIT command.  IF EXIT is used, the process will
  294. terminate at that point and control will never be returned to
  295. the HST20 script.
  296.  
  297.  
  298. The combination script command files, AUTOEXEC.HSF, and @CMD is
  299. an extremely powerful one, which gives you almost total control
  300. over Qmodem externally, without making a single change to the
  301. HST20 script.  I recommend that you experiment very carefully 
  302. with these features and test them thoroughly before using them
  303. for productive purposes. 
  304.  
  305.  
  306. SUPPORT
  307.  
  308. I will attempt to correct problems with this script, as well as
  309. keep it current with releases of the HST's firmware and Qmodem
  310. software as time allows.  This is a personal effort which I
  311. am sharing, but for which I receive no remuneration (except from
  312. commercial or business users of the script, and I am still
  313. waiting for those).  Please make no unreasonable demands for
  314. support, especially for things that are not broken; you got this
  315. for free and if it does not perform as you would like it to, you
  316. have a God-given right not to use it.  You may also chose to
  317. alter the script to meet your unique requirements, although the
  318. new Command File facility should address all specific needs not
  319. covered in the script's generic menus.  If you modify HST20,
  320. please do not distribute your version under its original name.
  321. If you have questions or suggestions,  I can be contacted under
  322. my name on the Qmodem Support Conference Echo on the InterLink
  323. or SmartNet networks.
  324.  
  325.  
  326.  
  327. Dan Moore
  328. 1/19/1989
  329.