home *** CD-ROM | disk | FTP | other *** search
/ Kosovo Orphans' Appeal Charity CD / KosovoOrphansAppeal.iso / internet / software / _socketeer / _help / docs / _manual next >
Encoding:
Text File  |  1998-08-29  |  12.7 KB  |  272 lines
  1. ------------------------------------------------------------------------
  2.            Socketeer release 0.13                          (29 Aug 1998)
  3.  
  4.                                                         by Matthew Bloch
  5.                                                         <mattbee@eh.org>
  6. ------------------------------------------------------------------------
  7.  
  8.      ********************
  9.      *** What it does ***
  10.      ********************
  11.  
  12. Socketeer is (intended to be) a stress-free way of connecting an Acorn
  13. machine to the internet through a telephone (or ISDN) line.  I wrote it
  14. because there aren't any good, free, uncomplicated and reliable internet
  15. diallers around for RISC OS; certainly nothing to touch the ease of use of
  16. Windows 95's Dial-Up Networking.
  17.  
  18.      ************************
  19.      *** What you'll need ***
  20.      ************************
  21.  
  22. These need to be installed on your computer for Socketeer to work:
  23.  
  24. - Acorn's latest Toolbox modules (from around December '97)
  25. - !FreeNet or !Internet
  26. - The ANT / Acorn Resolver module
  27. - !SerialDev, the block serial drivers
  28. - Either Sergio Monesi's or Acorn's PPP module
  29.     (Sergio's PPP driver will only be used if it is registered, and thus not
  30.      subject to the 15-minute connection time)
  31.  
  32. Note that the PPP, PPPdriver and Resolver modules (except for FreeNet's)
  33. *must* go inside the !System.Modules.310.Network folder, otherwise Socketeer
  34. won't find them (though you can alter this easily enough, I want to keep
  35. standards!).
  36.  
  37. Also, make sure you have a suitable Choices folder set up-- this should be
  38. fine with all RISC PCs, and older machines as long as they use Acorn's !Boot
  39. structure.
  40.  
  41. If you are lacking any of these, you ought to go to
  42.  
  43.    http://www.soup-kitchen.demon.co.uk/software/socketeer.html
  44.  
  45. before continuing, or ask your nearest friendly PD library for the
  46. relevant modules (such as APDL) if you don't have internet access.
  47.  
  48.      ******************
  49.      *** Setting up ***
  50.      ******************
  51.  
  52. Copy Socketeer to wherever you can find it most easily, or (like me) in your
  53. !Boot.Choices.Boot.Tasks folder so it loads on startup.  After loading it for
  54. the first time, go straight to the Setup... window off the main icon, rename
  55. the Default setup, and enter the details of your internet connection into the
  56. relevant boxes.  If you have accounts with more than one service provider,
  57. click 'Add...' and repeat the process for as many accounts as you have. 
  58. Before clicking on 'Save changes...', make sure you've chosen the account you
  59. wish to use primarily.
  60.  
  61.  Modem
  62.  ~~~~~
  63. The Modem setup is all pretty standard: the only thing you might need
  64. to change is the speed if your modem doesn't support 115200 baud, or if
  65. you've got an old computer which won't go above 19200.  The 'Drop connection
  66. cleanly' option will mean that Socketeer trusts your PPP module to drop the
  67. connection rather than dropping the DTR line; I'd suggest you only use this
  68. if you know what it means ;-)
  69.  
  70.  Internet provider
  71.  ~~~~~~~~~~~~~~~~~
  72. If you don't know what the internet provider settings mean, give your ISP's
  73. helpdesk a call, explain your situation, and they'll be able to fill in the
  74. fields for you.  Same for your account details, though they should have sent
  75. you these by post.  PEOPLE USING ACORN'S PPP MODULE TAKE NOTE!  You'll need
  76. to put a PAPSecrets file inside your !Internet.files.PPP folder, of the
  77. format:
  78.  
  79. j.smith * password
  80.  
  81. (e.g. your login name, a space, then an asterisk, then a space, then your
  82. password, then a new line) for as many accounts as you use PAP with.  Also,
  83. since 0.12 you *must* explicitly enter your ISP's gateway address so that the
  84. connection monitoring code knows your nearest 'external' internal address.
  85.  
  86. PLEASE NOTE that despite appearances, the only connection types supported are
  87. PPP and PPP (PAP) which seems to cover 99% of commercial ISPs.  I'm working
  88. on SLIP and the rest, honestly!
  89.  
  90.  Your account
  91.  ~~~~~~~~~~~~
  92. This is where you put your login details: your ISP should have sent you
  93. these.  If you don't want Socketeer keeping track of your password (which is
  94. stored unencrypted on your hard drive), you can ask for it to prompt you,
  95. either before it even dials, or it can prompt you at the moment 'when
  96. needed', i.e. at the moment it needs to send your password to the ISP for
  97. confirmation.
  98.  
  99. The reason I put this second option in is for people who need to use 'key
  100. fobs' to generate passwords which are sometimes time-critical to within a few
  101. seconds.  For the uninitiated, some companies are worried enough about
  102. security that they issue little credit-card sized 'key fobs' which generate a
  103. password given the current time, so that people not possessing these cannot
  104. possibly use the company system.
  105.  
  106.  Connection management
  107.  ~~~~~~~~~~~~~~~~~~~~~
  108. Socketeer can be made to dial your internet provider unattended at various
  109. times of the day.  If you specify, for instance:
  110.  
  111.   0900 1200 1600-1700
  112.  
  113. ...Socketeer will connect at 9am, 12pm and 4pm daily (and in this case, the
  114. 4pm connection will disconnect an hour later); if you do not specify a time
  115. for the connection to be terminated, Socketeer will use the idle time, so
  116. that once your mail has finished downloading, disconnection will occur within
  117. the time you specify.
  118.  
  119. To explain: after an 'idle' period where no internet traffic has gone
  120. backwards or forwards, Socketeer will disconnect the modem to save on your
  121. phone bill.  This 'idle' time also applies to connections you initiate
  122. yourself, in case you leave a download going then go off to make the tea like
  123. I do sometimes ;-)  The only problem is that due to the way that Socketeer
  124. monitors the status of your connection, there is always some residual 'ping'
  125. traffic going backwards and forwards, so it also asks you to set an idle
  126. threshold, i.e. the maximum amount of traffic that Socketeer can count as
  127. 'idle'.  See the statistics section later for more on this.
  128.  
  129. Specifying a disconnection time like that is useful if you want to be able to
  130. telnet into your Demon (or other fixed IP) account while away for the day.
  131.  
  132. 'Retry dead connections' specifies the number of times Socketeer will retry a
  133. connection if the packet driver dies prematurely, that is to say if the modem
  134. has successfully made a connection and BT has debited 5p from your phone
  135. bill.  If a connection was started automatically, the redial will happen
  136. immediately; if you initiated the connection, you'll be asked.
  137.  
  138. The online and offline scripts are files or applications which will be run
  139. when Socketeer connects or disconnects-- note that the offline script will
  140. not be run if Socketeer doesn't successfully get online.
  141.  
  142. DISCLAIMER: Please note that although I have tested these features to the
  143. best of my ability, you use them at your own risk and I will not be held
  144. responsible for connections which have stayed open all day, either by
  145. misconfiguration or bugs in the software.  Having said this, I entrust
  146. Socketeer to check my mail while I'm out or asleep, so if it happens to you,
  147. divine justice will mean it'll probably happen to me at some point.
  148.  
  149.  Front-end
  150.  ~~~~~~~~~
  151. Here are three miscellaneous options which are largely a matter of taste:
  152.  
  153. 'No sound effects' turns off the audible warnings Socketeer gives when the
  154. connection is faltering, or when it is about to idle out.
  155.  
  156. 'Confirm disconnections' will ask you to confirm your actions every time you
  157. ask Socketeer to disconnect.
  158.  
  159. 'Right hand button open stats' changes the default action of the right-hand
  160. button on the icon-bar.  Normally it acts as a short-cut to connect and
  161. disconnect you from the internet, but you may want it to open the Statistics
  162. window instead.
  163.  
  164.  Launcher
  165.  ~~~~~~~~
  166. Click the 'Launcher...' button to edit the application launcher
  167. configuration: this is still a bit raw, since you'll have to edit a text file
  168. which simply contains lines of the following format:
  169.  
  170. <application path><TAB><sprite to use><TAB><text to display underneath>
  171.  
  172. e.g. mine reads (verbatim):
  173.  
  174. ADFS::Buttercup.$.Internet.Clients.!Fresco    !fresco    Fresco
  175. ADFS::Buttercup.$.Internet.Clients.!Talker    !talker    Talker
  176. ADFS::Buttercup.$.Internet.Newsbase.!Messenger    !messenger    Messenger
  177. ADFS::Buttercup.$.Internet.Clients.!ANTterm    !antterm    Terminal
  178. ADFS::Buttercup.$.Internet.Clients.!FTPclient    !ftpclient    FTP
  179. ADFS::Buttercup.$.Internet.Clients.Tools.!Ping    !ping    Ping
  180. ADFS::Buttercup.$.Internet.!Attacher    !attacher    Attacher
  181. ADFS::Buttercup.$.Internet    directory    Open Internet folder
  182.  
  183. and the file format is pretty strict: you should only put one tab inbetween
  184. each field, and make sure the last entry has a newline after it, otherwise
  185. Bad Things will happen.
  186.  
  187. Technical note: Each item will be Filer_Booted when Socketeer starts up, and
  188. Filer_Run when double-clicked on to minimise Socketeer's involvement with the
  189. relevant applications.  Hence ou can hold down shift while double-clicking to
  190. open application folders too.
  191.  
  192.      **************
  193.      *** In use ***
  194.      **************
  195.  
  196. Once you have chosen a setup, Socketeer will connect and disconnect when you
  197. tell it to: clicking the right-hand button on the main icon mirrors the
  198. functionality of the menu option and the big button in the main window. 
  199. Also, Socketeer will notice if the PPP module disconnects for some reason,
  200. though it won't always be able to help you diagnose why.
  201.  
  202. If your connection is within the 'idle' threshold you specified in the setup
  203. window, you'll see Zs appear on the icon.  If you're seeing these Zs when
  204. your connection *isn't* idle, or you're not seeing them when it *is*, you
  205. need to adjust your setup slightly; see under 'statistics'.
  206.  
  207. If Socketeer detects that the connection is faltering, a white exclamation
  208. mark will appear on the icon-bar.  After a little more time (usually
  209. about 10secs), when Socketeer is convinced something is amiss, a visual and
  210. audible warning will appear.  After a little longer, Socketeer will assume
  211. the connection is stuffed, and disconnect.  See below for more detail on
  212. this.
  213.  
  214. Every time you connect or disconnect from the internet, Socketeer will write
  215. the time and date to its log file, which you can analyse later by clicking on
  216. 'Call log...' from the main menu.
  217.  
  218.      *****************************
  219.      *** Statistics and idling ***
  220.      *****************************
  221.      
  222. You can open the statistics window by choosing it from the icon-bar menu, or,
  223. if you've ticked the appropriate box in the Front-end section of the Setup,
  224. you can click adjust on the icon-bar icon.  The first and most obvious thing
  225. it shows is the CONNECT speed reported by the modem; this ought to reflect
  226. the baud rate at which you have connected to your ISP, though it can change
  227. midway and you wouldn't know anything about it.
  228.  
  229. Also, while online, Socketeer will regularly 'ping' your ISP's gateway
  230. address (i.e. the nearest machine to you on the internet) to check that the
  231. modem and your internet provider are still responding properly.  A ping is so
  232. called because it expects a response from the address that it pings, a little
  233. like sonar.  If Socketeer doesn't get a response within 2 seconds, it counts
  234. this towards your connection's 'Latency'-- this indicator will slowly
  235. increase if your connection is unreliable, and will disconnect after 20 pings
  236. have not been responded to.  The Latency indication is only worth paying
  237. attention to if you suspect something is wrong with your connection: to gauge
  238. the actual speed, have a look at the 'Traffic' bar which will tell you how
  239. much data is being passed through your modem.  Note that the exclaimation
  240. mark apeears on the icon bar after 2 lost pings, and the audible warning
  241. after 10.
  242.  
  243. Socketeer decides whether your connection is 'idle' by looking at the traffic
  244. bar every half-second and comparing it against the idle threshold in the
  245. current setup.  When idle, you'll see Zs appear on the icon bar.  To
  246. calibrate your idle threshold (and I apologise for this unsatisfactory way of
  247. doing things), connect Socketeer to your ISP and watch the traffic indicator:
  248. it will most likely flicker between zero and a lowish reading.  Your idle
  249. threshold should be set a bit above this; don't worry if the reading jumps up
  250. occasionally as Socketeer will ignore uncharacteristics 'blips' in the
  251. traffic.  No, I don't know why it does it either ;-)
  252.  
  253.      ********************
  254.      *** Other issues ***
  255.      ********************
  256.  
  257. Some may find it worrying that Socketeer doesn't use any scripting: I decided
  258. not to go for event a simple script language because 99% of ISPs I've
  259. encountered ask users to login in exactly the same ways.  What it does is to
  260. read a list of prompts and responses to expect from the server; this file is
  261. called Prompts, and is stored in '!Socketeer.Bits'.  If you find Socketeer
  262. can't log you in, it's probably because your ISP's prompts are not stored in
  263. this file: please mail me any useful additions to this (Technical
  264. note: ESPECIALLY if you find Socketeer can't cope in a particular situation,
  265. or you've had to bodge something which ought to be included in the
  266. front-end).
  267.  
  268. ta ra,
  269.  
  270. -- 
  271. Matthew
  272.