home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / infomtch.zip / infomtch.doc < prev    next >
Text File  |  1995-09-20  |  10KB  |  212 lines
  1. Infomatch Internet OS/2 Warp SLIP Connect Script
  2. Written by Graham TerMarsch (gtermars@infomatch.com)
  3. Version 1.5: September 17, 1995
  4. ----------------------------------------------------
  5.  
  6. This is the documentation file for the Infomatch Internet OS/2 Warp SLIP
  7. Connection Script (hereafter referred to as, "the script").  Please refer to
  8. the README file for more information regarding distribution and restrictions
  9. of usage for this script and the accompanying files.
  10.  
  11. In this file you'll find information on how to get the script up and running
  12. for yourself with the OS/2 Warp IAK.  If you have problems getting this script
  13. to run, please feel free to contact me; send e-mail to gtermars@infomatch.com
  14. containing a subject line of "Infomatch connect script".
  15.  
  16. Please note that the script is a customization (ok, SERIOUS customization) of
  17. the ANNEX.CMD script that is distributed with the OS/2 Warp IAK.  Portions of
  18. the script have been written by Harold Roussel (roussel@physics.mcgill.ca).
  19.  
  20. -------------------------------------------------------------------------------
  21. Features:
  22.  
  23. - Redial capability
  24. - Audible notification of successful connection or failure to connect to host
  25. - Ability to start other applications upon successful connection
  26. - Command line arguments to turn on/off features as well as set username,
  27.   password, etc.
  28.  
  29. NOTE:   To properly use the redial capability of this script, you must have
  30.         updated your SLIP dialer to a recent version.  Use your 'Retrieve
  31.         Software Updates' icon in the IAK folder to update your version if
  32.         you are unsure of it's level.
  33.  
  34.         The dialer will then have to be 'patched'; by default, the slip dialer
  35.         will hang up and abort dialing if it detects the string 'BUSY', 'NO
  36.         CARRIER', or several others.  Because these strings are directly
  37.         related to the fact that we'd like to do redial, we need to patch the
  38.         dialer.  I've included a SLIPPTCH.EXE program which will patch the
  39.         dialer program for you.  Please read the SLIPPTCH.DOC file for
  40.         instructions on its usage.
  41.  
  42. -------------------------------------------------------------------------------
  43. DISCLAIMER:
  44.  
  45. You were waiting for this, weren't you?  Well, it's a standard disclaimer; I've
  46. managed to get this working on my machine and have thus provided it to others.
  47. By use of this script you acknowledge that I am not responsible for any damages
  48. that may be incurred through it's use, either directly or indirectly.  Yes, I
  49. am available to answer your questions if you have a problem, but I take no
  50. responsibility for your actions.  You downloaded it, and if you use it you take
  51. full responsibility into your own hands.  If you do not agree with this then
  52. simply discontinue use of this script.
  53.  
  54. -------------------------------------------------------------------------------
  55. COMMAND LINE ARGUMENTS:
  56.  
  57. There are several command line arguments that can be used to help customize the
  58. script for your own usage.  Arguments are not case sensitive.
  59.  
  60. -ATTEMPTS xx
  61.         Sets the maximum number of attempts that will be used for dialing to
  62.         'xx'.  A value of 0 signifies that the script should continue to dial
  63.         until a connection is made.  The default value is zero.
  64.  
  65. -NAME xxx
  66.         Sets the username to log into Infomatch Internet with to 'xxx'.  If no
  67.         username is given, the script will ask for one before dialing.
  68.  
  69. -PASSWORD xxx
  70.         Sets the password to log into Infomatch Internet with to 'xxx'.  If no
  71.         password is given, the script will ask for one before dialing.
  72.  
  73. -BEEP xxx
  74.         Sets whether or not the script should beep when either a successful
  75.         connection has been made or the script has failed to connect.  Valid
  76.         values are 'ON' and 'OFF'.  The default value is 'ON'.
  77.  
  78. -AUTOSTART xxx
  79.         Sets whether or not the script should automatically start a REXX script
  80.         file called LOGGEDIN.CMD which is assumed to be somewhere on your path.
  81.         Valid values are 'ON' and 'OFF'.  The default value is 'ON'.
  82.  
  83. -ADDRESS xxx.xxx.xxx.xxx
  84.         Sets your IP address.  This is the address that Infomatch Internet has
  85.         given to your for your connections.  Enter the address in dotted
  86.         decimal notation (ie. 199.60.99.1).  If no address is given, the script
  87.         will ask for one before dialing.
  88.  
  89. -------------------------------------------------------------------------------
  90. HOW TO SETUP YOUR DIALER WITH THIS SCRIPT:
  91.  
  92. Following, find the necessary options that need to be set in the Dial Other
  93. Internet Provider application in order to get the best usage out of this
  94. script.  Have your IP address and username handy.  If you find that there are
  95. entries in your entry that do not appear here it is because they do not affect
  96. the usage of this script (however, they should still be set as needed).
  97.  
  98. Login Info:
  99.   Login ID:             (leave blank)
  100.   Password:             (leave blank)
  101.   Required:             (uncheck this checkbox)
  102.   Phone Number:         (leave blank)
  103.   Login Sequence:       infomtch.cmd [arguments]
  104.          Example:       infomtch.cmd -address 199.60.99.13 -name slip123
  105.                         -password xxx -beep on -autostart off -attempts 0
  106.  
  107.          This sets up the script to log you in as user 'slip123' with password
  108.          'xxx', audible notification on, infinite dialing attempts, and an IP
  109.          address of 199.60.99.13 for your computer.
  110.  
  111.   Connection Type:      SLIP
  112.  
  113. Connect Info:
  114.   MTU Size:             1500
  115.   VJ Compression:       Enabled
  116.   Domain Nameserver:    199.60.99.1
  117.   Your Domain Name:     infomatch.com
  118.  
  119. Server Info:
  120.   News server:          news.infomatch.com
  121.   WWW server:           www.infomatch.com
  122.   POP mail server:      pop3.infomatch.com
  123.   Reply domain:         infomatch.com
  124.   Reply ID:             (your username)
  125.   POP login ID:         (your username)
  126.   POP password:         (your password)
  127.  
  128. Modem Info:
  129.   Set up this page as is necessary for your particular modem.  If you find that
  130.   there are several items that are unavailable for you to enter data into,
  131.   don't worry.
  132.  
  133. -------------------------------------------------------------------------------
  134. HOW TO USE THE AUTOSTART FEATURE:
  135.  
  136. Upon successful connection, the script will attempt to start a REXX script file
  137. called LOGGEDIN.CMD.  This script file should contain the commands required to
  138. start any applications that you wish to have running upon each and every login.
  139. It is assumed that the LOGGEDIN.CMD file is somewhere on your path.  I've
  140. placed mine in the \TCPIP\BIN directory.
  141.  
  142. Note that the LOGGEDIN.CMD file must contain all of the commands needed to set
  143. up the application into it's working directory and start the application; some
  144. applications need to be in a specified working directory when they are started.
  145.  
  146. When starting your applications, it is preferable to use the 'DETACH' command
  147. instead of the 'START' command; START causes an entire command shell to be
  148. started while DETACH only starts the requested application.  The last line of
  149. your LOGGEDIN.CMD script file MUST be 'EXIT'; otherwise you will have one
  150. extra open command line shell.
  151.  
  152. Sample LOGGEDIN.CMD file:
  153.  
  154.    REM **********************************************************************
  155.    REM *** Mail reader.  PMMail requires that you be in the working directory
  156.    REM *** when the application is started.
  157.    REM **********************************************************************
  158.    D:
  159.    CD \PMMail
  160.    DETACH PMMail.Exe
  161.  
  162.    REM **********************************************************************
  163.    REM *** Finished, exit this command shell.
  164.    REM **********************************************************************
  165.    EXIT
  166.  
  167. -------------------------------------------------------------------------------
  168. REVISION HISTORY:
  169.  
  170. 1.5, September 17, 1995
  171.         Added the ability to turn on/off any of the features as well as
  172.         customize the behaviour of the script.  This has significant changes
  173.         regarding the command line arguments.
  174.  
  175. 1.4, September 7, 1995
  176.         Added functionality to automatically start a REXX script file called
  177.         LOGGEDIN.CMD upon a successful connection.  This script file must be
  178.         somewhere upon your path.
  179.  
  180. 1.3, August 10, 1995
  181.         Altered the behaviour so that the dialing is no longer heard, and
  182.         added an audible notification to the user for both a successful
  183.         connection as well as failure to connect.
  184.  
  185. 1.2, July 26, 1995
  186.         Internal code alteration.  Modified to make easier to read as well as
  187.         changed the way that the redialing is handled.
  188.  
  189. 1.1, July 14, 1995
  190.         Added Harold Roussel's waitfor2 and waitfor3 routines to make the
  191.         script more robust regarding busy signals and bad connections
  192.  
  193. 1.0, ???
  194.         Initial release.  Featured redial capability.
  195.  
  196. -------------------------------------------------------------------------------
  197. CONTACTING THE AUTHOR:
  198.  
  199. I can be reached by e-mail at gtermars@infomatch.com.  If you do not have
  200. e-mail access, I can be reached by snail mail at:
  201.  
  202.         Graham TerMarsch
  203.         #701-1555 Harwood St.
  204.         Vancouver, B.C.
  205.         Canada     V6G 1X8
  206.  
  207. Note that I have no connection with Infomatch Internet other than that I am a
  208. user of their service.  I am not employed by Infomatch Internet, and receive no
  209. payment for this script.  However, if you do find this script useful, any $$$
  210. or spare computer parts that you can send along would be greatly appreciated.
  211. :-)
  212.