home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / internet / scrpthlp / SCRIPTHLP
Text File  |  1995-07-01  |  22KB  |  666 lines
  1. # $Id: ScriptHelp 1.6 95/06/25 09:54:32 root Exp Locker: root $
  2.  
  3. ScriptHelp
  4. ==========
  5.  
  6. This help file applies to R.Orwin/A.P. Fitch slipdial script.
  7. Script file Revision 1.6
  8.  
  9. Contents
  10. --------
  11.  
  12. 1.0 Introduction
  13.  
  14. 2.0 Using the script
  15.  
  16. 3.0 Script Requirements
  17.  3.1 Modem Driver
  18.  3.2 Setting up your modem to transmit status messages
  19.  3.3 Making sure that TTFN etc have been "seen".
  20.  
  21. 4.0 Customizing the script
  22.  4.1 The contents of the configuration file, !slipdial.scripts.demconfg
  23.  4.2 To change the default dialler to Mercury.
  24.   4.2.1 To remove your Mercury PIN from a local number.
  25.  4.3 To Alter the Dialler Menu.
  26.  4.4 To Alter the List of Numbers
  27.  4.5 To Alter the Number of Retries.
  28.  4.6 To Change the Local Dialler Icon Number. 
  29.  
  30. 5.0 Some Frequently Asked Questions.
  31.  
  32. 6.0 Conclusions and Acknowledgements. 
  33.  
  34. 1.0 Introduction
  35. ================
  36.  
  37. This script was originally written by Rob Orwin.  I initially modified 
  38. to make it more readable, and also to learn the script language
  39. myself. Recently it has been customised to work with TTFN/Newsbase,
  40. and included in Dr. Alan Hassey's Internet Starter Pack for Acorn 
  41. Computers.
  42.  
  43. Changes made to version 1.5/1.6
  44. -------------------------------
  45.  
  46. The script has been largely re-written, mainly so that all
  47. configuration information is held in the file
  48. !slipdial.scripts.demconfg. So that new and old configuration files
  49. are not confused, the the configuration file is now called "demconfg"
  50. instead of "demonconfg".
  51.  
  52. The main advantage of these changes are 
  53.  
  54.    1) the script should start up faster
  55.    2) changes may be made to the phone numbers dialled without editing
  56.       the script (i.e. only demconfg has to be edited).
  57.       
  58. Two additional configuration options have been added 
  59.  
  60.    1) it is now possible to specify a number in the configuration file 
  61.       which will NOT have the mercury prefix added 
  62.    2) it is now possible to specify the default "local" number as a
  63.       completely separate item.  In the past, it was assumed that the
  64.       "local" number would not require a mercury prefix - this is not
  65.       always the case, so they have been made separate.
  66.  
  67. Finally, error reporting has been improved
  68.  
  69.    1) if the call fails due to not receiving the login, password, or 
  70.       protocol prompts, you will be told what caused the failure.
  71.  
  72.       
  73. 2.0 Using the script
  74. ====================
  75.  
  76. The script is placed in the !SlipDial.scripts directory.  You can
  77. either load it by dragging it and dropping it on the SlipDial icon bar
  78. icon, or you can set SlipDial up to run the script automatically.  You
  79. should read the SlipDial documentation file !SlipDial.!Help to
  80. understand this.
  81.  
  82. For the default setup with the starter pack, the scriptfile should be
  83. named
  84.  
  85. !SlipDial.scripts.demon
  86.  
  87. When the script is run for the first time, it asks for setup
  88. information and stores it in a configuration file.  This version of
  89. the script has  more information stored in the configuration file, and
  90. so may ask you for the information again, even if you have previously
  91. stored it.
  92.  
  93. There are a number of requirements for getting the script to work in
  94. the best way.  In particular, you need to
  95.  
  96. 1) make sure you are using the correct modem driver file
  97. 2) set up your modem to return certain messages
  98. 3) make sure that TTFN, NewsBase, and TCPIP have been "seen" by the filer
  99.  
  100. There are also a number of ways you can customise your setup.  The
  101. simplest ones are 
  102.  
  103. 1)  to change the default dialler to Mercury
  104. 2)  to alter the entries that appear on the menu for dialling
  105. 3)  to alter the default entries when dialling a list of phone numbers
  106. 4)  to alter the number of times SlipDial retries each number if the
  107.     line is busy 
  108. 5)  to change the local number 
  109.  
  110.  
  111. >From version 1.5 onwards of the script, these changes may be made by
  112. editing the file !slipdial.scripts.demconfg (known hereinafter as the
  113. "configuration file").
  114.  
  115. Note that to make changes to the script or the configuration, you
  116. simply have  to use a normal text editor, e.g. Edit.
  117.  
  118. With !SlipDial, there is a file called !SlipDial.scripts.DemonSpr,
  119. which  contains sprite definitions.  You must make sure you have the
  120. most up-to-date version of these sprites. If the file contains three
  121. sprites, you are ok - if it only contains 2, you should update it to
  122. the latest one by downloading it from demon ftp.
  123.  
  124. 3.0 Script Requirements
  125. =======================
  126.  
  127. 3.1 Modem Driver
  128. ----------------
  129.  
  130. The modem drivers are stored in the directory !SlipDial.Drivers. 
  131. There are examples for a number of modems.  The driver is  set when
  132. the configuration file is first stored (normally when you first run
  133. the script).  Simply answer the question wih the driver you wish to
  134. use.
  135.  
  136. 3.2 Setting up your modem to transmit status messages
  137. -----------------------------------------------------
  138.  
  139. If you run the script, and it appears to hangup after the call has got
  140. through but before TCPIP has started; or it doesn't recognise that the
  141. line is busy; then you need to make sure that the modem is returning
  142. messages indicating its (the modem's) status.  These messages are text
  143. strings, and their meaning is defined in the  driver file.  For
  144. instance, with the US Robotics Sportster modem, you need to send the
  145. setup string "X4" to enable all messages.
  146.  
  147. This means that when the modem detects the line is busy, it will
  148. return the string "BUSY".  You can tell the script to expect the
  149. string "BUSY" to indicate engaged by putting it in the modem driver
  150. file and assigning it to the script variable $busy. When dialling the
  151. modem looks for the string to see if it is equal to the contents of
  152. $busy and uses this to detect engaged lines.
  153.  
  154. The various possible strings, and their setups for a USR modem are
  155. shown in the example driver file below
  156.  
  157. set $init "ATB0E1F1M1Q0S7=30V1X4 AT&A2&B1&C1&D2&H1&I0 AT&K3&M4&N0&R2&S0&Y1"
  158. set $busy "BUSY"
  159. set $conn "CONNECT"
  160. set $nocarr "NO CARRIER"
  161. set $nodial "NO DIAL TONE"
  162.  
  163. The $init string is sent to the modem to set it up.  You will notice that
  164. the example above has X4 enabled.     
  165.  
  166. If you have a modem which returns different strings, you would have to 
  167. create your own modem driver.  For instance, if your modem returned
  168. "ENGAGED", you would have to modify the driver file to contain
  169.  
  170. set $busy "ENGAGED"
  171.  
  172. 3.3 Making sure that TTFN etc have been "seen".
  173. -----------------------------------------------
  174.  
  175. The script runs TTFN, Newsbase, and TCPIP automatically.  To do this,
  176. it needs to know where they are.  It can find them if you have opened
  177. a filer window with these programmes visible.  The  simplest way to
  178. ensure that they have been seen is to put all the internet related
  179. programmes in one directory.  Then when you open the directory in
  180. order to double-click SlipDial, you  know that all the other
  181. programmes have been seen.
  182.  
  183. 4.0 Customizing the Script
  184. ==========================
  185.  
  186. 4.1 The contents of the configuration file, !slipdial.scripts.demconfg
  187. ----------------------------------------------------------------------
  188.  
  189. A typical configuration file looks like this.
  190.  
  191. SP_DualPC               <-- the required block driver
  192. 0                       <-- port number
  193. 57600                   <-- computer to modem speed
  194. cycle                   <-- your host name
  195. password                <-- your password
  196. USR                     <-- the modem driver
  197. bt                      <-- telephone service provider 
  198. 131,999999999           <-- your mercury pin
  199. IsleOfWight             <-- menu entry 1 title
  200. 01983523306             <-- menu entry 1 phone number
  201. Reading                 <-- menu entry 2 title
  202. 01734284848             <-- menu entry 2 phone number
  203. London                  <-- menu entry 3 title
  204. 01813384848             <-- menu entry 3 phone number
  205. 01983523306             <-- the local (default) number
  206. 01983523306             <-- a number which should NOT be prefixed 
  207.                             with a mercury pin 
  208.  
  209. Normally this would be set up by running !DemConfg, if you use
  210. the Demon internet starter pack. However if you need to change
  211. something later, here is a description of what each option means.
  212.  
  213. 4.1.1 Block Driver
  214. ------------------
  215.  
  216. This is the block driver name. It should be set to match with your computer, and the type of modem