add CTY-3304
[spider.git] / html / connect.html
index 5ad00ccf71770b34101dd0e5ebe09bcd5e8698fd..4a4eaa3cd86dadb7e583a7e3b9d7b6b58964982c 100644 (file)
@@ -20,7 +20,7 @@
        <p>
          <!-- Created: Sun Dec 13 20:25:14 GMT 1998 -->
          <!-- hhmts start -->
-Last modified: Sun Sep  2 21:12:19 BST 2001
+Last modified: Sun Sep  2 22:02:36 BST 2001
 <!-- hhmts end -->
        <p>At the moment, anybody can connect inwards at any time from outside, either by ax25 or by
          telnet (assuming you have followed the instructions in <a href="install.html">installation</a>
@@ -64,14 +64,13 @@ Last modified: Sun Sep  2 21:12:19 BST 2001
     <span class=cmd>client gb7djk telnet</span>
        </pre>
 
-       <p>a ax25 example (connecting from GB7DJK, to GB7DXM via my local BPQ node and one X1J intermediate node):-
+       <p>An ax25 example (connecting from GB7DJK, to GB7DXM via my local BPQ node and one X1J intermediate node):-
 
        <pre>
     <span class=cmd>timeout 60</span>
     <span class=cmd>abort (Busy|Sorry|Fail)</span>
     # don't forget to chmod 4775 netrom_call!
     <span class=connect>connect ax25 /usr/sbin/netrom_call bbs gb7djk-0 g1tlh-0</span>
-    <span class=expect>'Connected'</span> <span class=send>''</span>
     <span class=expect>'Connected'</span> <span class=send>'c np7'</span>
     <span class=expect>'*** Connect'</span> <span class=send>'c gb7dxm'</span>
     <span class=expect>'Connect'</span> <span class=send>''</span>
@@ -79,15 +78,20 @@ Last modified: Sun Sep  2 21:12:19 BST 2001
 
     <p>The <tt>-0</tt> ssid is important if you want it to work reliably. Obviously if you are
     using a different ssid then you would use that. You can use the Netrom alias instead if it
-       it is in the machines node table</p>
+       it is in the machines node table.</p>
 
-    <p>A AGW Engine example would be very similar and look like this:-</p>
+       <p>The line: "<tt><span class=expect>'Connected'</span> <span class=send>''</span></tt>" means: wait for
+         the string <span class=expect>Connected</span> and when that is seen, then move onto the next line
+         <b>without <span class=send>sending</span> anything</b>. The reason you do this (in this case) is to wait
+       for the final "connect" string from the BPQ node that directly connects you to the
+       cluster node itself.</p>
+
+    <p>An AGW Engine example would be very similar and look like this:-</p>
 
        <pre>
     <span class=cmd>timeout 60</span>
     <span class=cmd>abort (Busy|Sorry|Fail)</span>
     <span class=connect>connect agw 2 g1tlh</span>
-    <span class=expect>'*** Connected'</span> <span class=send>''</span>
     <span class=expect>'*** Connect'</span> <span class=send>'c np7'</span>
     <span class=expect>'Connected'</span> <span class=send>'c gb7dxm'</span>
     <span class=expect>'Connect'</span> <span class=send>''</span>
@@ -163,17 +167,20 @@ Last modified: Sun Sep  2 21:12:19 BST 2001
          route that you are going to take to the destination, so this will be typically the callsign
          of your local node.</p>
 
-    <p>You will notice that the script waits until it sees the left hand string
-         of the pair and <b>only then</b> does it send the, 
-         string on the right 
-         hand side. This is called a <i>State Machine</i>.</p>
-
-       <p>A <i>state machine</i> "walks" through a conversation (in this case) looking
-         for "states" (in this case particular strings) and then performs some
-         "action" (usually some kind of connect command for the type of system
-         you are trying to navigate). When one "state" "fires" (detects the string
-         are looking for), it sends the command associated with that state and then 
-         moves onto the next "state", in our case: the next line.</p>
+    <p>You will notice that the script <span class=expect>waits</span>
+    until it sees the left hand string of the pair and <b>only
+    then</b> does it <span class=send>send</span> the string on the
+    right hand side. This is called a <i>State Machine</i>.</p>
+
+       <p>A <i>state machine</i> "walks" through a conversation (in this
+       case) looking for "<span class=expect>states</span>" (in this case
+       particular strings) and then performs some "<span
+       class=send>action</span>" (usually some kind of connect command
+       for the type of system you are trying to navigate). When one
+       "<span class=expect>state</span>" "fires"
+       (detects the string are looking for), it <span class=send>sends the command</span>
+       associated with that state and then moves onto the next "<span
+       class=expect>state</span>", in our case: the next line.</p>
 
        <p><b>PLEASE NOTE</b>: the colouration in the above example is for illustrative purposes
          only, the debug output is all one colour.</p>
@@ -187,18 +194,18 @@ Last modified: Sun Sep  2 21:12:19 BST 2001
                ignored, as are wholly blank lines.
         <br><br>
 
-               <li><b>timeout</b> followed by a number is the number of
+               <li><b><span class=cmd>timeout</span></b> followed by a number is the number of
                seconds to wait for a command to complete. If there is no
-               <b>timeout</b> specified in the script then the default is 60
+               <b><span class=cmd>timeout</span></b> specified in the script then the default is 60
                seconds.
         <br><br>
 
-               <li><b>abort</b> is a regular expression containing one or
+               <li><b><span class=cmd>abort</span></b> is a regular expression containing one or
                more strings to look for to abort a connection. This is a perl
                regular expression and is executed ignoring case.
         <br><br>
 
-               <li><b>connect</b> followed by <b>ax25</b>, <b>telnet</b> or <b>agw</b>
+               <li><b><span class=connect>connect</span></b> followed by <b>ax25</b>, <b>telnet</b> or <b>agw</b>
                and some type dependent information. 
 
         <p>In the case of a
@@ -206,34 +213,40 @@ Last modified: Sun Sep  2 21:12:19 BST 2001
                the first is the ip address or hostname of the computer you
                wish to connect to and the second is the port number you want
                to use (this can be left out if it is a normal telnet
-               session).
+               session).</p>
 
                <p>In the case of an <b>ax25</b> session then this would
                normally be a call to <tt>/usr/sbin/ax25_call</tt> or
                <tt>/usr/sbin/netrom_call</tt> as in the example above. It is your
                responsibility to get your node and other ax25 parameters to
-               work before going down this route!
+               work before going down this route!</p>
 
         <p>For <b>agw</b> connections you will need a port number (starting
-        from 1) and the callsign of the first &quot;hop&quot; along the way.
-        <br><br>
+        from 1) and the callsign of the first &quot;hop&quot; along the way.</p>
 
-               <li><b>'</b> is the delimiting character for a word or
-               phrase of an expect/send line in a <tt>chat</tt> type
-               script. The words/phrases normally come in pairs, either can
-               be empty. Each line reads input from the connection until it
-               sees the string (or perl regular expression) contained in the
-               left hand string. If the left hand string is empty then it
-               doesn't read or wait for anything. The comparison is done
-               ignoring case.
+               <li><b>'</b> is the delimiting character for a word or phrase
+               of an <span class=expect>expect</span>/<span
+               class=send>send</span> line.  The words/phrases normally come
+               in pairs, but either can be empty. Each line reads input from
+               the connection until it sees the string (or perl regular
+               expression) that 
+               is contained in the left hand string. 
 
-               <p>When the left hand string has found what it is looking (if
-               it is) then the right hand string is sent to the connection.
+               <p>When the <span class=expect>left hand string</span> has found what it is <span class=expect>expecting</span> (if
+               it is) then the <span class=send>right hand string</span> is <span class=send>sent</span> to the connection.</p>
 
-               <p>This process is repeated for every line of <tt>chat</tt> script. 
-        <br><br>
+               <p>If the <span class=expect>left hand
+               string</span> is empty then it doesn't read or wait for anything, it
+               simply <span class=send>sends</span> whatever is on the <span class=send>right hand side</span>.</p> 
+
+               <p>All comparisons are done ignoring case.</p>
+
+               <p>If the <span class=send>right hand string</span> is empty ('') then nothing is <span class=send>sent</span>, the 
+                 script simply moves onto the next line.</P>
+
+               <p>This process is repeated for every line of <tt>chat</tt> script.</p> 
 
-               <li><b>client</b> starts the connection, put the arguments
+               <li><b><span class=cmd>client</span></b> starts the connection, put the arguments
                you would want here if you were starting the client program
                manually. You only need this if the script has a different
                name to the callsign you are trying to connect to (i.e. you