yet more doc changes
[spider.git] / sgml / adminmanual.sgml
index b956474f8cf5aad33abdbc7427b8c93aa6834802..39ec64313b937908ad8d4ef2e42b24baf9191516 100644 (file)
@@ -4,9 +4,10 @@
 
 <!-- Title information -->
 
-<title>The DXSpider Installation and Administration Manual 
-<author>Ian Maude, G0VGS, (ianmaude@btinternet.com)
-<date>Version 1.34 (Revision 1.0) April 2001
+<title>The DXSpider Installation and Administration Manual</title> 
+<author>Ian Maude, G0VGS, (ianmaude@btinternet.com)</author>
+<date>Version 1.47 (Revision 1.30), April 2001</date>
+
 <abstract>
 A reference for SysOps of the DXSpider DXCluster program.
 </abstract>
@@ -45,10 +46,9 @@ following modules from <htmlurl url="http://www.cpan.org/CPAN.html" name="http:/
 <P>
 <itemize>
 
-<item>         MD5-1.7.tar.gz
-<item>         Data-Dumper-2.10.tar.gz
-<item>         TimeDate-1.08.tar.gz
-<item>         IO-1.20.tar.gz
+<item>         Data-Dumper-2.101.tar.gz
+<item>         TimeDate-1.10.tar.gz
+<item>         IO-1.20.tar.gz (for perl 5.00403 and lower)
 <item>         Net-Telnet-3.02.tar.gz
 <item>         Curses-1.05.tar.gz
 <item>         Time-HiRes-01.20.tar.gz
@@ -255,7 +255,7 @@ should see the output on your screen and hopefully now have a small C program
 called <em>client</em>.  Leave it in this directory.
 
 
-<sect>Quick installation guide
+<sect>Quick installation guide (Linux version)
 
 <P>
 This section is designed for experienced Spider sysops who want to install
@@ -275,7 +275,7 @@ is the user that should be doing that process.
 <item>Fix permissions on ax25_call and netrom_call (root)
 <item>Login as the sysop user
 <item>cd to /spider (sysop)
-<item>mkdir local (sysop
+<item>mkdir local (sysop)
 <item>mkdir local_cmd (sysop)
 <item>cp perl/DXVars.pm.issue local/DXVars.pm (sysop)
 <item>cd to /spider/local and edit DXVars to set your details (sysop)
@@ -329,8 +329,23 @@ or, if you wish your users to be able to use SSID's on their callsigns ..
 default  * * * * * *  - sysop /spider/src/client client %s ax25
 </verb></tscreen>
 
-<sect1>Allowing telnet connects from users
+For most purposes this is not desirable. The only time you probably will 
+need this is when you need to allow other cluster nodes that are using SSID's
+in. In this case it would probably be better to use the first example and 
+then add a specific line for that node like this:
+
+<tscreen><verb>
+GB7DJK-2  * * * * * *  - sysop /spider/src/client client gb7djk-2 ax25
+default  * * * * * *  - sysop /spider/src/client client %u ax25
+</verb></tscreen>
+<sect1>Allowing telnet connects from users 
 
+<P> 
+From version 1.47 there is a new (more efficient) way of doing this
+(see next section) but, if you prefer, the method of doing it described 
+here will continue to work just fine.
 <P>
 Allowing telnet connections is quite simple.  Firstly you need to add a line 
 in /etc/services to allow connections to a port number, like this ....
@@ -346,7 +361,6 @@ spdlogin stream tcp nowait root /usr/sbin/tcpd /spider/src/client login telnet
 </verb></tscreen>
 
 <P>
-This needs to be added above the standard services such as ftp, telnet etc.  
 Once this is done, you need to restart inetd like this ....
 
 <tscreen><verb>
@@ -375,6 +389,84 @@ telnet localhost 8000
 <P>
 You should now get the login prompt and be able to login as before.
 
+<sect1>Setting up telnet connects (from 1.47 onwards)
+
+<P>
+From version 1.47 you can choose to allow the perl cluster.pl program to 
+allow connections directly (i.e. not via the <tt>/spider/src/client</tt>
+interface program). If you are using Windows then this is the only method
+available of allowing incoming telnet connections.
+
+<P>
+To do this you need first to remove any line that you may previously have set
+up in /etc/inetd.conf. Remember to:-
+
+<tscreen><verb>
+killall -HUP inetd
+</verb></tscreen>
+
+<P>
+to make the change happen...
+
+<P>
+Having done that, you need to copy the file 
+<em>/spider/perl/Listeners.pm</em> to <em>/spider/local</em> and 
+then edit it. You will need to uncomment the line containing &dquot;0.0.0.0&dquot; 
+and select the correct port to listen on. So that it looks like this:-
+
+<tscreen><verb>
+@listen = (
+    ["0.0.0.0", 8000],
+);
+</verb></tscreen>
+
+<P>
+As standard, the listener will listen on all interfaces simultaneously. 
+If you require more control than this, you can specify each interface 
+individually:-
+
+<tscreen><verb>
+@listen = (
+    ["gb7baa.dxcluster.net", 8000],
+    ["44.131.16.2", 6300],
+);
+</verb></tscreen>
+
+<P>
+This will only be successful if the IP addresses on each interface are static. 
+If you are using some kind of dynamic IP addressing then the 'default' method 
+is the only one that will work.
+
+<P>
+Restart the cluster.pl program to enable the listener.
+
+<P>
+One important difference with the internal listener is that no echoing 
+is done by the cluster program. Users will need to set 'local-echo' on in 
+their telnet clients if it isn't set automatically (as per the standards). 
+Needless to say this will probably only apply to Windows users. 
+
+<sect1>Setting up for AGW Engine (1.47 onwards)
+
+<P>
+AGW Engine is a Windows based ax25 stack. You can connect to an AGW engine 
+from Linux as well as Windows based machines.
+
+<P>
+In order to enable access to an AGW Engine you need to copy 
+<em>/spider/perl/AGWConnect.pm</em> to <em>/spider/local</em> and edit it. 
+Specifically you must:-
+
+<itemize>
+<item> set <tt>$enable</tt> to 1.
+<item> set <tt>$login</tt> and <tt>$passwd</tt> to the values set up in your AGW installation. 
+If you haven't set any there, then you should not touch these values.
+<item> You can connect to a remote AGW engine (ie on some other machine) by changing <tt>$addr</tt>
+and <tt>$port</tt> appropriately.
+<item> Restart the cluster.pl program
+</itemize>   
+
+
 <sect1>Setting up node connects
 
 <P>
@@ -434,6 +526,15 @@ If the callsign you just set up as a cluster node is for an incoming connect,
 this is all that needs to be done.  If the connection is to be outgoing then 
 a connection script needs to be written.
 
+<P>
+Sometimes you make a mistake... Honest, it does happen.  If you want to make a node
+back to being a normal user, regardless
+of what type it is, do:
+
+<tscreen><verb>
+unset/node gb7baa
+</verb></tscreen>
+
 <sect1>Connection scripts
 
 <P>
@@ -446,20 +547,20 @@ Writing a script for connections is therefore relatively simple.
 The connect scripts consist of lines which start with the following keywords 
 or symbols:-
 
-<verb>
+<descrip>
        
-#              All lines starting with a # are ignored, as are completely 
+<tag/#/All lines starting with a <tt>#</tt> are ignored, as are completely 
                 blank lines.
 
-timeout                timeout followed by a number is the number of seconds to wait for a 
+<tag/timeout/<tt>timeout</tt> followed by a number is the number of seconds to wait for a 
                command to complete. If there is no timeout specified in the script 
                then the default is 60 seconds.
 
-abort          abort is a regular expression containing one or more strings to look 
+<tag/abort/    <tt>abort</tt> 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.
 
-connect                connect followed by ax25 or telnet and some type dependent 
+<tag/connect/<tt>connect</tt> followed by ax25, agw (for Windows users) or telnet and some type dependent 
                information. In the case of a telnet connection, there can be up to 
                two parameters.
                The first is the ip address or hostname of the computer you wish to 
@@ -470,7 +571,7 @@ connect             connect followed by ax25 or telnet and some type dependent
                responsibility to get your node and other ax25 parameters to work 
                before going down this route!
 
-'              ' is the delimiting character for a word or phrase of an expect/send 
+<tag/'/<tt>'</tt> is the delimiting character for a word or phrase of an expect/send 
                line in a chat 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
@@ -480,16 +581,16 @@ connect           connect followed by ax25 or telnet and some type dependent
                then the right hand string is sent to the connection.
                This process is repeated for every line of chat script. 
 
-client         client starts the connection, put the arguments you would want here 
+<tag/client/<tt>client</tt> 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 have a script called other which actually 
                connects to GB7DJK-1 [instead of a script called gb7djk-1]).
-</verb>
+</descrip>
 
 
-There are many possible ways to configure the script but here are two examples, 
-one for a NETRom/AX25 connect and one for tcp/ip.  
+There are many possible ways to configure the script but here are three examples, 
+one for a NETRom/AX25 connect, one for AGW engines and one for tcp/ip.  
 
 <tscreen><verb>
 timeout 60
@@ -505,6 +606,21 @@ client gb7dxm ax25
 
 <P>
 
+<tscreen><verb>
+timeout 60
+abort (Busy|Sorry|Fail)
+# this does exactly the same as the previous example
+# the '1' is the AGW port number to connect thru for g1tlh
+connect agw 1 g1tlh
+'Connect' '' 
+'Connect' 'c np7'
+'Connect' 'c gb7dxm'
+# you can leave this out if you call the script 'gb7dxm'
+client gb7dxm ax25
+</verb></tscreen>
+
+<P>
+
 <tscreen><verb>
 timeout 15
 connect telnet dirkl.tobit.co.uk
@@ -533,7 +649,8 @@ G0VGS de GB7MBC 13-Dec-1998 2043Z >
 
 This will start a connection using the script called <em>gb7djk-1</em>.  You can
 follow the connection by watching the term or console from where you started
-<em>cluster.pl</em>.  You should see something like this ...
+<em>cluster.pl</em>.  From version 1.47 onwards, you will need to <tt>set/debug connect</tt> first.
+You should see something like this ...
 
 <tscreen><verb>
 <- D G1TLH connect gb7djk-1
@@ -602,7 +719,7 @@ on the route taken to connect.
 <P>
 Telnet echo itself should only be a problem if the connection is being made to 
 the telnet port (23).  This port uses special rules that include echo negotiation.
-If the connection is to a different port, such as 8000, this negotiation does 
+If the connection is to a different port, such as 7300, this negotiation does 
 not happen and therefore no echo should be present.
 
 <P>
@@ -696,7 +813,7 @@ a comment)
 # check every 10 minutes to see if gb7xxx is connected and if not
 # start a connect job going
 
-0,10,20,30,40,50 * * * * start_connect('gb7xxx') if !connected('gb7xxx')
+0,10,20,30,40,50 * * * * start_connect('gb7xxx') if unless connected('gb7xxx')
 </verb></tscreen>
 
 <P>
@@ -4063,6 +4180,43 @@ for more information.
 Display all the bad spotter's callsigns in the system, see SET/BADSPOTTER
 for more information.
 
+<sect1>show/configuration (0)
+
+<P>
+<tt>
+<bf>show/configuration &lsqb;&lt;node&gt;&rsqb;</bf> Show all visible nodes and their users
+</tt>
+
+<P>
+This command allows you to see all the users that can be seen
+and the nodes to which they are connected.  With the optional <em>node</em>,
+you can specify a particular node to look at.
+
+This command is normally abbreviated to: sh/c
+
+BE WARNED: the list that is returned can be VERY long
+
+<sect1>show/configuration/node (0)
+
+<P>
+<tt>
+<bf>show/configuration/node</bf> Show all the nodes connected
+</tt>
+
+<P>
+Show all the nodes connected locally and the nodes they have connected.
+
+<sect1>show/connect (1)
+
+<P>
+<tt>
+<bf>show/connect</bf> Show all the active connections
+</tt>
+
+<P>
+This command shows information on all the active connections known to
+the node. This command gives slightly more information than WHO.
+
 <sect1>show/date (0)
 
 <P>