-<!doctype linuxdoc system>
-
-<article>
-
-<!-- Title information -->
-
-<title>The DXSpider Installation and Administration Manual
-<author>Ian Maude, G0VGS, (ianmaude@btinternet.com)
-<date>Version 1.24 July 2000
-<abstract>
-A reference for SysOps of the DXSpider DXCluster program.
-</abstract>
-
-<!-- Table of contents -->
-<toc>
-
-<!-- Begin the document -->
-
-<sect>Installation (Original version by Iain Phillips, G0RDI)
-
-<P>
-Last modified: 25 July 2000 by Ian Maude, G0VGS
-
-<sect1>Introduction
-
-<P>
-This section describes the installation of DX Spider v1.35 on a <htmlurl url="http://www.redhat.com" name="RedHat"> Linux Distribution. I do not intend to try and cover the installation of Linux or the setup of the AX25 utilities. If you need help on this then read Iains original HOWTO on the <htmlurl url="http://www.dxcluster.org" name="DXSpider"> website.
-
-<P>
-I am assuming a general knowledge of Linux and its commands. You should know how to use <em>tar</em> and how to edit files using your favourite editor.
-
-<P>
-The crucial ingredient for all of this is <htmlurl url="http://www.perl.org" name="Perl 5.004">.Now I know Perl 5.005 is out and this will almost certainly work with it, but <htmlurl url="http://www.redhat.com" name="RedHat 5.1"> comes with 5.004. <em>Be Warned</em>, earlier versions of <htmlurl url="http://www.redhat.com" name="RedHat"> <bf>do not</bf> come with 5.004 as standard, you need to <htmlurl url="ftp://upgrade.redhat.com" name="upgrade">
-
-<P>In addition to the standard Red Hat distribution you will require the following <htmlurl url="http://www.cpan.org/CPAN.html" name="CPAN"> modules: -
-
-<P>
-<itemize>
-
-<item> MD5-1.7.tar.gz
-<item> Data-Dumper-2.10.tar.gz
-<item> FreezeThaw-0.3.tar.gz
-<item> MLDBM-2.00.tar.gz
-<item> TimeDate-1.8.tar.gz
-<item> IO-1.20.tar.gz
-<item> Net-Telnet-3.02.tar.gz
-<item> Curses-1.05.tar.gz
-
-</itemize>
-
-<P>
-
-<em>Do</em> get the latest versions of these packages and install them but use the above list as the earliest versions usable.
-
-<sect1>Preparation
-
-<P>
-I will assume that you have already downloaded the latest tarball of the DXSpider software and are ready to install it. I am assuming version 1.35 for this section but of course you would use the latest version.
-
-<P>
-Login as root and create a user to run the cluster under. <bf><it>UNDER NO CIRCUMSTANCES USE ROOT AS THIS USER!</it></bf>. I am going to use the name <em>sysop</em>. You can call it anything you wish. Depending on your security requirements you may wish to use an existing user, however this is your own choice.
-
-<P>
-<tscreen><verb>
-# adduser -m sysop
-</verb></tscreen>
-
-<P>
-Now set a password for the user ...
-
-<tscreen><verb>
-# passwd sysop
-# New UNIX password:
-# Retype new UNIX password:
-passwd: all authentication tokens updated successfully
-</verb></tscreen>
-
-<sect1>Installing the software
-
-<P>
-Now to unpack the DX Spider distribution, set symbolic links and group permissions. Copy the tarball to /home/sysop and do the following.
-
-<tscreen><verb>
-# cd ~sysop
-# tar xvfz spider-1.35.tar.gz
-# ln -s ~sysop/spider /spider
-# groupadd -g 251 spider (or another number)
-</verb></tscreen>
-
-If you do not have the command <em>groupadd</em> available to you simply add a line in /etc/group by hand.
-
-<tscreen><verb>
-# vi /etc/group (or your favorite editor)
-</verb></tscreen>
-
-You also need to add some others to the group, including your own callsign (this will be used as an alias) and root. The finished line in /etc/group should look something like this
-
-<tt>
-spider:x:251:sysop,g0vgs,root
-</tt>
-
-<P>
-The next step is to set the permissions on the Spider directory tree and files ....
-
-<tscreen><verb>
-# chown -R sysop.spider spider
-# find . -type d -exec chmod 2775 {} \;
-# find . -type f -exec chmod 775 {} \;
-</verb></tscreen>
-
-<P>
-This last step allows various users of the group <em>spider</em> to have write access to all the directories. This is not really needed just yet but will be useful when web interfaces start to appear.
-
-<P>
-Finally, you need to fix the permissions on the ax25_call and netrom_call programs. Check where they are with the <em>locate</em> command and alter the permissions with the <em>chmod</em> command like this ..
-
-<tscreen><verb>
-# chown root ax25_call netrom_call
-# chmod 4775 ax25_call netrom_call
-</verb></tscreen>
-
-<sect1>Setting callsigns etc
-
-<P>
-Now login to your machine as the user you created earlier. In my case that user is called <em>sysop</em>. Once logged in, issue the following commands ....
-
-<tscreen><verb>
-$ cd /spider
-$ mkdir local
-$ mkdir local_cmd
-$ cp perl/DXVars.pm.issue local/DXVars.pm
-$ cd local
-$ vi DXVars.pm (or your favourite editor)
-</verb></tscreen>
-
-<P>
-Using the distributed DXVars.pm as a a template, set your cluster callsign, sysop callsign and other user info to suit your own environment. Note that this a perl file which will be parsed and executed as part of the cluster. If you get it wrong then perl will complain when you start the cluster process. It is important only to alter the text of any section. Some of the lines look a little odd. Take this line for example ....
-
-<tt>
-$myemail = "ianmaude\@btinternet.com";
-</tt>
-
-<P>
-There appears to be an extra slash in there. However this has to be there for the file to work so leave it in.
-
-<P><bf>PLEASE USE CAPITAL LETTERS FOR CALLSIGNS</bf>
-
-<P>
-DON'T alter the DXVars.pm (or any other file) in /spider/perl, they are overwritten with every release. Any files or commands you place in /spider/local or /spider/local_cmd will automagically be used in preference to the ones in /spider/perl EVEN while the cluster is running!
-
-<P>
-Save the new file and change directory to ../perl ....
-
-<tscreen><verb>
-$ cd ../perl
-</verb></tscreen>
-
-<P>
-Now type the following command which creates the basic user file with you as the sysop.
-
-<tscreen><verb>
-$ create_sysop.pl
-</verb></tscreen>
-
-<sect1>Starting up for the first time
-
-<P>
-We can now bring spider up for the first time and see if all is well or not! It should look something like this ...
-
-<tscreen><verb>
-$ cluster.pl
-DXSpider DX Cluster Version 1.35
-Copyright (c) 1998 Dirk Koopman G1TLH
-loading prefixes ...
-loading band data ...
-loading user file system ...
-starting listener ...
-reading existing message headers
-reading cron jobs
-orft we jolly well go ...
-</verb></tscreen>
-
-<P>
-If all is well then login on another term or console as <em>sysop</em> and cd to /spider/perl. Now issue the following command ...
-
-<tscreen><verb>
-$ client.pl
-</verb></tscreen>
-
-<P>
-This should log you into the cluster as the sysop under the alias callsign we set earlier. In this case the callsign is G0VGS. The cluster callsign is set in the DXVars.pm file in /spider/local. In this case we will assume that this was set as GB7MBC. You should therefore see this when you login ....
-
-<tscreen><verb>
-G0VGS de GB7MBC 19-Nov-1999 2150Z >
-</verb></tscreen>
-
-If you do, congratulations! If not, look over the instructions again, you have probably missed something out. You can shut spider down again with the command ....
-
-<tscreen><verb>
-shutdown
-</verb></tscreen>
-
-<P>
-and both the cluster and the client should return to Linux prompts.
-
-<sect>The Client program
-
-<P>
-In earlier versions of Spider, all the processes were Perl scripts. This was fine but with a lot of users your computer memory would soon be used up. To combat this a new client was written in "C". This client only works for <em>incoming</em> connects at the moment. Before you can use it though it has to be "made". CD to /spider/src and type <em>make</em>. You 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>Configuration
-
-<sect1>Allowing ax25 connects from users
-
-<P>
-As stated previously, the aim of this document is not to tell you how to configure Linux or the ax25 utilities. However, you do need to add a line in your ax25d.conf to allow connections to DXSpider for your users. For each interface that you wish to allow connections on, use the following format ...
-
-<tscreen><verb>
-default * * * * * * - sysop /spider/src/client client %u ax25
-</verb></tscreen>
-
-<sect1>Allowing telnet connects from users
-
-<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 ....
-
-<tscreen><verb>
-spdlogin 8000/tcp # spider anonymous login port
-</verb></tscreen>
-
-Then add a line in /etc/inetd.conf like this ....
-
-<tscreen><verb>
-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>
-killall -HUP inetd
-</verb></tscreen>
-
-
-<P>Now login as <em>sysop</em> and cd spider/perl. You can test that spider is accepting telnet logins by issuing the following command ....
-
-<tscreen><verb>
-client.pl login telnet
-</verb></tscreen>
-
-You should get a login prompt and on issuing a callsign, you will be given access to the cluster. Note, you will not get a password login. There seems no good reason for a password prompt to be given so it is not asked for.
-
-<P>
-Assuming all is well, then try a telnet from your linux console ....
-
-<tscreen><verb>
-telnet localhost 8000
-</verb></tscreen>
-
-<P>
-You should now get the login prompt and be able to login as before.
-
-<sect1>Setting up node connects
-
-<P>
-In order to allow cluster node connections, spider needs to know that the connecting callsign is a cluster node. This is the case whether the connect is incoming or outgoing.
-In spider this is a simple task and can be done in runtime.
-
-<P>
-Start up the cluster as you did before and login as the sysop with client.pl.
-The cluster node I am wanting to make a connection to is GB7BAA but you would obviously use whatever callsign you required.
-At the prompt type ...
-
-<tscreen><verb>
-set/node gb7baa
-</verb></tscreen>
-
-<P>
-The case does not matter as long as you have a version of DXSpider later than 1.33. Earlier versions required the callsign to be in upper case.
-
-<P>
-That is now set, it is as simple as that. To prove it, login on yet another console as sysop and issue the command ...
-
-<tscreen><verb>
-client.pl gb7baa (using the callsign you set as a node)
-</verb></tscreen>
-
-<P>
-You should get an initialisation string from DXSpider like this ...
-
-<tscreen><verb>
-client.pl gb7baa
-PC38^GB7MBC^~
-</verb></tscreen>
-
-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.
-
-<sect2>Connection scripts
-
-<P>
-Because DXSpider operates under Linux, connections can be made using just about any protocol; AX25, NETRom, tcp/ip, ROSE etc are all possible examples. Connect scripts live in the /spider/connect directory and are simple ascii files. Writing a script for connections is therefore relatively simple.
-
-<P>
-The connect scripts consist of lines which start with the following keywords or symbols:-
-
-
-<verb>
-
-# All lines starting with a # are ignored, as are completely blank lines.
-
-timeout timeout 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
- 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
- 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
- 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).
- In the case of an ax25 session then this would normally be a call to
- ax25_call or netrom_call as in the example above. It is your
- 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
- 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
- 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.
- When the left hand string has found what it is looking for (if it is)
- 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
- 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>
-
-
-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.
-
-<tscreen><verb>
- timeout 60
- abort (Busy|Sorry|Fail)
- # don't forget to chmod 4775 netrom_call!
- connect ax25 /usr/sbin/netrom_call bbs gb7djk 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
- 'login' 'gb7djk'
- 'word' 'gb7djk'
- # tell GB7DJK-1 that it is connected to GB7DJK
- # you can leave this out if you call this script 'gb7djk'
- client gb7djk telnet
-</verb></tscreen>
-
-<P>
-Both these examples assume that everything is set up properly at the other end. You will find other examples in the /spider/examples directory.
-
-<sect2>Starting the connection
-
-<P>
-You start the connection, from within a sysop enabled cluster login, by typing in the word <em>connect</em> followed by a script name like this ....
-
-<tscreen><verb>
-G0VGS de GB7MBC 13-Dec-1998 2041Z >connect gb7djk-1
-connection to GB7DJK-1 started
-G0VGS de GB7MBC 13-Dec-1998 2043Z >
-</verb></tscreen>
-
-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 ...
-
-<tscreen><verb>
-<- D G1TLH connect gb7djk-1
--> D G1TLH connection to GB7DJK-1 started
--> D G1TLH G1TLH de GB7DJK 13-Dec-1998 2046Z >
-timeout set to 15
-CONNECT sort: telnet command: dirkl.tobit.co.uk
-CHAT "login" -> "gb7djk"
-received "
-Red Hat Linux release 5.1 (Manhattan)
-Kernel 2.0.35 on an i586
-"
-received "login: "
-sent "gb7djk"
-CHAT "word" -> "gb7djk"
-received "gb7djk"
-received "Password: "
-sent "gb7djk"
-Connected to GB7DJK-1, starting normal protocol
-<- O GB7DJK-1 telnet
--> B GB7DJK-1 0
-GB7DJK-1 channel func state 0 -> init
-<- D GB7DJK-1
-<- D GB7DJK-1 Last login: Sun Dec 13 17:59:56 from dirk1
-<- D GB7DJK-1 PC38^GB7DJK-1^~
-<- D GB7DJK-1 PC18^ 1 nodes, 0 local / 1 total users Max users 0 Uptime 0 00:00^5447^~
- etc
-
-</verb></tscreen>
-
-<P>
-With later versions of Spider there is a set/login command for users. This tells them when a user or node logs in or out. If you do not add a line to your scripts after the final line (or before the client line which should always be last if needed) then the login/logout information will be sent to users <it>before</it> the login actually completes. This means if a node is unreachable, it will continue sending logins and logouts to users even though it is not actually connecting. To avoid this use the following line ...
-
-<tscreen><verb>
-'connect' ''
-</verb></tscreen>
-
-<P>
-In a script, this might look like ...
-
-<tscreen><verb>
-timeout 35
-abort (Busy|Sorry|Fail)
-connect telnet mary 3000
-'ogin:' 'gb7mbc'
-'>' 'telnet 44.131.93.96 7305'
-'connect' ''
-</verb></tscreen>
-
-<sect1>Automating things
-
-<P>
-Ok, you should now have DXSpider running nicely and allowing connects by cluster nodes or users. However, it has to be shutdown and restarted manually and if connection scripts fail they have to be started again manually too, not much use if you are not at the console!
-So, in this section we will automate both. Firstly starting the cluster.
-
-<sect2>Autostarting the cluster
-
-<P>
-This is not only a way to start the cluster automatically, it also works as a watchdog, checking the sanity of DXSpider and respawning it should it crash for any reason.
-Before doing the following, shutdown the cluster as you did earlier.
-
-<P>
-Login as root and bring up the /etc/inittab file in your favourite editor. Add the following lines to the file near the end ...
-
-<tscreen><verb>
-##Start DXSpider on bootup and respawn it should it crash
-DX:3:respawn:/bin/su -c "/usr/bin/perl -w /spider/perl/cluster.pl" sysop >/dev/tty7
-</verb></tscreen>
-
-<P>
-This will automatically start DXSpider on tty7 (ALT-F7) on bootup and restart it should it crash for any reason.
-
-<P>
-As root type the command <em>telinit q</em>. DXSpider should start up immediately. You will see the output on tty7 and if you login as <em>sysop</em> you should find everything running nicely.
-
-<P>
-So far so good, now to automate script connections...
-
-<sect2>The crontab file
-
-<P>
-Login as <em>sysop</em> and create a file in /spider/local_cmd called crontab. Edit it with your favourite editor and add a line like this (I have included a comment)
-
-<tscreen><verb>
-# 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')
-</verb></tscreen>
-
-<P>
-The callsign involved will be the callsign of the cluster node you are going to connect to. This will now check every 10 minutes to see if gb7xxx is connected, if it is then nothing will be done. If it is not, then a connect attempt will be started.
-
-<P>
-There are probably lots of other things you could use this crontab file for. If you want to know more about it, look at the <htmlurl url="http://www.dxcluster.org/cron.html" name="DXSpider"> website at the cron page where it is explained more fully.
-
-<sect>Hop control
-
-<P>
-Starting with version 1.13 there is simple hop control available on a per
-node basis. Also it is possible to isolate a network completely so that you
-get all the benefits of being on that network, but can't pass on information
-from it to any other networks you may be connected to (or vice versa).
-
-<sect1>Basic hop control
-
-<P>
-In /spider/data you will find a file called hop_table.pl. This is the file that controls your hop count settings. It has a set of default hops on the various PC frames and also a set for each node you want to alter the hops for. You may be happy with the default settings of course, but this powerful tool can help to protect and improve the network. The file will look something like this ...
-
-<tscreen><verb>
-#
-# hop table construction
-#
-
-package DXProt;
-
-# default hopcount to use
-$def_hopcount = 5;
-
-# some variable hop counts based on message type
-%hopcount =
-
- 11 => 10,
- 16 => 10,
- 17 => 10,
- 19 => 10,
- 21 => 10,
-);
-
-
-# the per node hop control thingy
-
-
-%nodehops =
-
- GB7ADX => { 11 => 8,
- 12 => 8,
- 16 => 8,
- 17 => 8,
- 19 => 8,
- 21 => 8,
- },
-
- GB7UDX => { 11 => 8,
- 12 => 8,
- 16 => 8,
- 17 => 8,
- 19 => 8,
- 21 => 8,
- },
- GB7BAA => {
- 11 => 5,
- 12 => 8,
- 16 => 8,
- 17 => 8,
- 19 => 8,
- 21 => 8,
- },
-};
-</verb></tscreen>
-
-<P>
-Each set of hops is contained within a pair of curly braces and contains a series of PC frame types. PC11 for example is a DX spot. The figures here are not exhaustive but should give you a good idea of how the file works.
-
-<P>
-You can alter this file at any time, including whilst the cluster is running. If you alter the file during runtime, the command <em>load/hops</em> will bring your changes into effect.
-
-<sect1>Isolating networks
-
-<P>
-It is possible to isolate networks from each other on a "gateway" node using the
- <em>set/isolate <node_call></em> command.
-
-<P>
-The effect of this is to partition an isolated network completely from another
-nodes connected to your node. Your node will appear on and otherwise behave
-normally on every network to which you are connected, but data from an isolated
-network will not cross onto any other network or vice versa. However all the
-spot, announce and WWV traffic and personal messages will still be handled
-locally (because you are a real node on all connected networks), that is locally
-connected users will appear on all networks and will be able to access and
-receive information from all networks transparently. All routed messages will
-be sent as normal, so if a user on one network knows that you are a gateway for
-another network, he can still still send a talk/announce etc message via your
-node and it will be routed across.
-
-<P>
-The only limitation currently is that non-private messages cannot be passed down
-isolated links regardless of whether they are generated locally. This will change
-when the bulletin routing facility is added.
-
-<P>
-If you use isolate on a node connection you will continue to receive all information from the isolated partner, however you will not pass any information back to the isolated node. There are times when you would like to forward only spots across a link (maybe during a contest for example). To do this, isolate the node in the normal way and put in a filter in the /spider/filter/spots directory to override the isolate. This filter can be very simple and consists of just one line ....
-
-<tscreen><verb>
-$in = [
- [ 1, 0, 'd', 0, 3] # The last figure (3) is the hop count
-];
-</verb></tscreen>
-
-<P>
-There is a lot more on filtering in the next section.
-
-<sect>Filtering
-
-<P>
-Filters can be set for spots, announcements and WWV. You will find the directories for these under /spider/filter. You will find some examples in the directories with the suffix <em>.issue</em>. There are two types of filter, one for incoming information and one for outgoing information. Outgoing filters are in the form <em>CALLSIGN.pl</em> and incoming filters are in the form <em>in_CALLSIGN.pl</em>. Filters can be set for both nodes and users.
-
-<P>
-All filters work in basically the same way. There are several elements delimited by commas.
-There can be many lines in the filter and they are read from the top by the program.
-When writing a filter you need to think carefully about just what you want to achieve. You
-are either going to write a filter to <em>accept</em> or to <em>reject</em>.
-Think of a filter as having 2 main elements. For a reject filter, you would have a line
-or multiple lines rejecting the things you do not wish to receive and then a default
-line accepting everything else that is not included in the filter. Likewise, for an
-accept filter, you would have a line or multiple lines accepting the things you wish
-to receive and a default line rejecting everthing else.
-
-<P>
-In the example below, a user requires a filter that would only return SSB spots
-posted in Europe on the HF bands. This is achieved by first rejecting the CW section
-of each HF band and rejecting all of VHF, UHF etc based on frequency.
-Secondly, a filter rule is set based on CQ zones to only accept spots posted in
-Europe. Lastly, a default filter rule is set to reject anything outside the filter.
-
-<tscreen><verb>
-$in = [
- [ 0, 0, 'r', # reject all CW spots
- [
- 1800.0, 1850.0,
- 3500.0, 3600.0,
- 7000.0, 7040.0,
- 14000.0, 14100.0,
- 18068.0, 18110.0,
- 21000.0, 21150.0,
- 24890.0, 24930.0,
- 28000.0, 28180.0,
- 30000.0, 49000000000.0,
- ] ,1 ],
- [ 1, 11, 'n', [ 14, 15, 16, 20, 33, ], 15 ], #accept EU
- [ 0, 0, 'd', 0, 1 ], # 1 = want, 'd' = everything else
-];
-</verb></tscreen>
-
-<P>
-The actual elements of each filter are described more fully in the following sections.
-
-<sect1>Spots
-
-<P>
-The elements of the Spot filter are ....
-
-<tscreen><verb>
-[action, field_no, sort, possible_values, hops]
-</verb></tscreen>
-
-<P>
-There are 3 elements here to look at. Firstly, the action element. This is very simple and only 2 possible states exist, accept (1) or drop (0).
-
-<P>
-The second element is the field_no. There are 13 possiblities to choose from here ....
-
-<tscreen><verb>
- 0 = frequency
- 1 = call
- 2 = date in unix format
- 3 = comment
- 4 = spotter
- 5 = spotted dxcc country
- 6 = spotter's dxcc country
- 7 = origin
- 8 = spotted itu
- 9 = spotted cq
- 10 = spotter's itu
- 11 = spotter's cq
- 12 = callsign of the channel on which the spot has appeared
-</verb></tscreen>
-
-<P>
-The third element tells us what to expect in the fourth element. There are 4 possibilities ....
-
-<tscreen><verb>
- n - numeric list of numbers e.g. [ 1,2,3 ]
- r - ranges of pairs of numbers e.g. between 2 and 4 or 10 to 17 - [ 2,4, 10,17 ]
- a - an alphanumeric regex
- d - the default rule
-</verb></tscreen>
-
-<P>
-The fifth element is simply the hops to set in this filter. This would only be used if the filter was for a node of course and overrides the hop count in hop_table.pl.
-
-<P>
-So, let's look at an example spot filter. It does not matter in the example who the filter is to be used for.
-So, what do we need in the filter? We need to filter the spots the user/node requires and also set a default rule for anything else outside the filter. Below is a simple filter that stops spots arriving from outside Europe.
-
-<tscreen><verb>$in = [
- [ 0, 4, 'a', '^(K|N|A|W|VE|VA|J)'], # 0 = drop, 'a' = alphanumeric
- [ 1, 0, 'd', 0, 1 ], # 1 = want, 'd' = everything else
- ];
-</verb></tscreen>
-
-<P>
-So the filter is wrapped in between a pair of square brackets. This tells Spider to look in between these limits. Then each line is contained within its own square brackets and ends with a comma.
-Lets look carefully at the first line. The first element is 0 (drop). Therefore anything we put on this line will not be accepted. The next element is 4. This means we are filtering by the spotter. The third element is the letter "a" which tells the program to expect an alphanumeric expression in the fourth element. The fourth element is a list of letters separated by the pipe symbol.
-
-<P>
-What this line does is tell the program to drop any spots posted by anyone in the USA, Canada or Japan.
-
-<P>
-The second line is the default rule for anything else. The "d" tells us this and the line simply reads... accept anything else.
-
-<P>
-You can add as many lines as you need to complete the filter but if there are several lines of the same type it is neater to enclose them all as one line. An example of this is where specific bands are set. We could write this like this ....
-
-<tscreen><verb>
-[ 0,0,'r',[1800.0, 2000.0], 1],
-[ 0,0,'r',[10100.0, 10150.0], 1],
-[ 0,0,'r',[14000.0, 14350.0], 1],
-[ 0,0,'r',[18000.0, 18200.0], 1],
-</verb></tscreen>
-
-<P>
-But the line below achieves the same thing and is more efficient ....
-
-<tscreen><verb>
- [ 0, 0, 'r',
- [
- 1800.0, 2000.0, # top band
- 10100.0, 10150.0, # WARC
- 14000.0, 14350.0, # 20m
- 18000.0, 18200.0, # WARC
- [ ,1 ],
-</verb></tscreen>
-
-
-<sect1>Announcements
-
-<P>
-<tscreen><verb>
-
-# This is an example announce or filter allowing only West EU announces
-#
-# The element list is:-
-# 0 - callsign of announcer
-# 1 - destination * = all, <callsign> = routed to the node
-# 2 - text
-# 3 - * - sysop, <some text> - special list eg 6MUK, ' ', normal announce
-# 4 - origin
-# 5 - 0 - announce, 1 - wx
-# 6 - channel callsign (the interface from which this spot came)
-
-$in = [
- [ 1, 0, 'a', '^(P[ABCDE]|DK0WCY|G|M|2|EI|F|ON)' ],
- [ 0, 0, 'd', 0 ]
-];
-</verb></tscreen>
-
-In this example, only the prefixes listed will be allowed. It is possible to be quite specific. The Dutch prefix "P" is followed by several secondary identifiers which are allowed. So, in the example, "PA" or "PE" would be ok but not "PG". It is even possible to allow information from a single callsign. In the example this is DK0WCY, to allow the posting of his Aurora Beacon.
-
-<sect1>WWV
-
-<P>
-<tscreen><verb>
-
-# This is an example WWV filter
-#
-# The element list is:-
-# 0 - nominal unix date of spot (ie the day + hour:13)
-# 1 - the hour
-# 2 - SFI
-# 3 - K
-# 4 - I
-# 5 - text
-# 6 - spotter
-# 7 - origin
-# 8 - incoming interface callsign
-
-# this one doesn't filter, it just sets the hop count to 6 and is
-# used mainly just to override any isolation from WWV coming from
-# the internet.
-
-$in = [
- [ 1, 0, 'd', 0, 6 ]
-];
-
-</verb></tscreen>
-
-<P>
-It should be noted that the filter will start to be used only once a user/node has logged out and back in again.
-<P>
-I am not going to spend any more time on these filters now as they will become more "comprehensive" in the near future.
-
-<sect1>Filtering Mail
-
-<P>
-In the /spider/msg directory you will find a file called badmsg.pl.issue. Rename this to badmsg.pl and edit the file. The original looks something like this ....
-
-<tscreen><verb>
-
-# the list of regexes for messages that we won't store having
-# received them (bear in mind that we must receive them fully before
-# we can bin them)
-
-
-# The format of each line is as follows
-
-# type source pattern
-# P/B/F T/F/O/S regex
-
-# type: P - private, B - bulletin (msg), F - file (ak1a bull)
-# source: T - to field, F - from field, O - origin, S - subject
-# pattern: a perl regex on the field requested
-
-# Currently only type B and P msgs are affected by this code.
-#
-# The list is read from the top down, the first pattern that matches
-# causes the action to be taken.
-
-# The pattern can be undef or 0 in which case it will always be selected
-# for the action specified
-
-
-
-package DXMsg;
-
-@badmsg = (
-'B', 'T', 'SALE',
-'B', 'T', 'WANTED',
-'B', 'S', 'WANTED',
-'B', 'S', 'SALE',
-'B', 'S', 'WTB',
-'B', 'S', 'WTS',
-'B', 'T', 'FS',
-);
-</verb></tscreen>
-
-<P>
-I think this is fairly self explanatory. It is simply a list of subject headers that we do not want to pass on to either the users of the cluster or the other cluster nodes that we are linked to. This is usually because of rules and regulations pertaining to items for sale etc in a particular country.
-
-<sect1>Filtering DX callouts
-
-<P>
-In the same way as mail, there are some types of spot we do not wish to pass on to users or linked cluster nodes. In the /spider/data directory you will find a file called baddx.pl.issue. Rename this to baddx.pl and edit the file. The original looks like this ....
-
-<tscreen><verb>
-
-# the list of dx spot addresses that we don't store and don't pass on
-
-
-package DXProt;
-
-@baddx = qw
-
- FROG
- SALE
- FORSALE
- WANTED
- P1RATE
- PIRATE
- TEST
- DXTEST
- NIL
- NOCALL
-);
-</verb></tscreen>
-
-<P>
-Again, this is simply a list of names we do not want to see in the spotted field of a DX callout.
-
-
-<sect>Information, files and useful programs
-
-<sect1>MOTD
-
-<P>
-One of the more important things a cluster sysop needs to do is to get information to his users. The simplest way to do this is to have a banner that is sent to the user on login. This is know as a "message of the day" or "motd". To set this up, simply create a file in /spider/data called motd and edit it to say whatever you want. It is purely a text file and will be sent automatically to anyone logging in to the cluster.
-
-<sect1>Downtime message
-
-<P>
-If for any reason the cluster is down, maybe for upgrade or maintenance but the machine is still running, a message can be sent to the user advising them of the fact. This message lives in the /spider/data directory and is called "offline". Simply create the file and edit it to say whatever you wish. This file will be sent to a user attempting to log into the cluster when DXSpider is not actually running.
-
-<sect1>Other text messages
-
-<P>
-You can set other text messages to be read by the user if they input the file name. This could be for news items or maybe information for new users. To set this up, make a directory under /spider called <em>packclus</em>. Under this directory you can create files called <em>news</em> or <em>newuser</em> for example. In fact you can create files with any names you like. These can be listed by the user with the command ....
-
-<tscreen><verb>
-show/files
-</verb></tscreen>
-
-They can be read by the user by typing the command ....
-
-<tscreen><verb>
-type news
-</verb></tscreen>
-
-If the file they want to read is called <em>news</em>. You could also set an alias for this in the Alias file to allow them just to type <em>news</em>
-
-<P>
-You can also store other information in this directory, either directly or nested under directories. One use for this would be to store DX bulletins such as the OPDX bulletins. These can be listed and read by the user. To keep things tidy, make a directory under /spider/packclus called <em>bulletins</em>. Now copy any OPDX or similar bulletins into it. These can be listed by the user in the same way as above using the <em>show/files</em> command with an extension for the bulletins directory you have just created, like this ....
-
-<tscreen><verb>
-show/files bulletins
-</verb></tscreen>
-
-<P>
-An example would look like this ....
-
-<tscreen><verb>
-sh/files
-bulletins DIR 20-Dec-1999 1715Z news 1602 14-Dec-1999 1330Z
-</verb></tscreen>
-
-You can see that in the files area (basically the packclus directory) there is a file called <em>news</em> and a directory called <em>bulletins</em>. You can also see that dates they were created. In the case of the file <em>news</em>, you can also see the time it was last modified, a good clue as to whether the file has been updated since you last read it. To read the file called <em>news</em> you would simply issue the command ....
-
-<tscreen><verb>
-type news
-</verb></tscreen>
-
-To look what is in the bulletins directory you issue the command ....
-
-<tscreen><verb>
-show/files bulletins
-opdx390 21381 29-Nov-1999 1621Z opdx390.1 1670 29-Nov-1999 1621Z
-opdx390.2 2193 29-Nov-1999 1621Z opdx391 25045 29-Nov-1999 1621Z
-opdx392 35969 29-Nov-1999 1621Z opdx393 15023 29-Nov-1999 1621Z
-opdx394 33429 29-Nov-1999 1621Z opdx394.1 3116 29-Nov-1999 1621Z
-opdx395 24319 29-Nov-1999 1621Z opdx396 32647 29-Nov-1999 1621Z
-opdx396.1 5537 29-Nov-1999 1621Z opdx396.2 6242 29-Nov-1999 1621Z
-opdx397 18433 29-Nov-1999 1621Z opdx398 19961 29-Nov-1999 1621Z
-opdx399 17719 29-Nov-1999 1621Z opdx400 19600 29-Nov-1999 1621Z
-opdx401 27738 29-Nov-1999 1621Z opdx402 18698 29-Nov-1999 1621Z
-opdx403 24994 29-Nov-1999 1621Z opdx404 15685 29-Nov-1999 1621Z
-opdx405 13984 29-Nov-1999 1621Z opdx405.1 4166 29-Nov-1999 1621Z
-opdx406 28934 29-Nov-1999 1621Z opdx407 24153 29-Nov-1999 1621Z
-opdx408 15081 29-Nov-1999 1621Z opdx409 23234 29-Nov-1999 1621Z
-Press Enter to continue, A to abort (16 lines) >
-</verb></tscreen>
-
-You can now read any file in this directory using the type command, like this ....
-
-<tscreen><verb>
-type bulletins/opdx391
-Ohio/Penn DX Bulletin No. 391
-The Ohio/Penn Dx PacketCluster
-DX Bulletin No. 391
-BID: $OPDX.391
-January 11, 1999
-Editor Tedd Mirgliotta, KB8NW
-Provided by BARF-80 BBS Cleveland, Ohio
-Online at 440-237-8208 28.8k-1200 Baud 8/N/1 (New Area Code!)
-Thanks to the Northern Ohio Amateur Radio Society, Northern Ohio DX
-Association, Ohio/Penn PacketCluster Network, K1XN & Golist, WB2RAJ/WB2YQH
-& The 59(9) DXReport, W3UR & The Daily DX, K3TEJ, KN4UG, W4DC, NC6J, N6HR,
-Press Enter to continue, A to abort (508 lines) >
-</verb></tscreen>
-
-The page length will of course depend on what you have it set to!
-
-<sect1>The Aliases file
-
-<P>
-You will find a file in /spider/cmd/ called Aliases. First, copy this file to /spider/local_cmd/Aliases and edit this file. You will see something like this ...
-
-<tscreen><verb>
-
-#!/usr/bin/perl
-
-# provide some standard aliases for commands for terminally
-# helpless ak1a user (helpless in the sense that they never
-# read nor understand help files)
-
-# This file is automagically reloaded if its modification time is
-# later than the one stored in CmdAlias.pm
-
-# PLEASE make this file consistant with reality! (the patterns MUST
-# match the filenames!)
-
-# Don't alter this file, copy it into the local_cmd tree and modify it.
-# This file will be replaced everytime I issue a new release.
-
-# You only need to put aliases in here for commands that don't work as
-# you desire naturally, e.g sh/dx on its own just works as you expect
-# so you need not add it as an alias.
-
-
-
-package CmdAlias;
-
-%alias = (
- '?' => [
- '^\?', 'apropos', 'apropos',
- ],
- 'a' => [
- '^ann.*/full', 'announce full', 'announce',
- '^ann.*/sysop', 'announce sysop', 'announce',
- '^ann.*/(.*)$', 'announce $1', 'announce',
- ],
- 'b' => [
- ],
- 'c' => [
- ],
- 'd' => [
- '^del', 'kill', 'kill',
- '^del\w*/fu', 'kill full', 'kill',
- '^di\w*/a\w*', 'directory all', 'directory',
- '^di\w*/b\w*', 'directory bulletins', 'directory',
- '^di\w*/n\w*', 'directory new', 'directory',
- '^di\w*/o\w*', 'directory own', 'directory',
- '^di\w*/s\w*', 'directory subject', 'directory',
- '^di\w*/t\w*', 'directory to', 'directory',
- '^di\w*/f\w*', 'directory from', 'directory',
- '^di\w*/(\d+)', 'directory $1', 'directory',
- ],
- 'e' => [
- ],
- 'f' => [
- ],
- 'g' => [
- ],
- 'h' => [
- ],
- 'i' => [
- ],
- 'j' => [
- ],
- 'k' => [
- ],
- 'l' => [
- '^l$', 'directory', 'directory',
- '^ll$', 'directory', 'directory',
- '^ll/(\d+)', 'directory $1', 'directory',
- ],
- 'm' => [
- ],
- 'n' => [
- '^news', 'type news', 'type',
- ],
- 'o' => [
- ],
- 'p' => [
- ],
- 'q' => [
- '^q', 'bye', 'bye',
- ],
- 'r' => [
- '^r$', 'read', 'read',
- '^rcmd/(\S+)', 'rcmd $1', 'rcmd',
- ],
- 's' => [
- '^s/p$', 'send', 'send',
- '^sb$', 'send noprivate', 'send',
- '^set/home$', 'set/homenode', 'set/homenode',
- '^set/nobe', 'unset/beep', 'unset/beep',
- '^set/nohe', 'unset/here', 'unset/here',
- '^set/noan', 'unset/announce', 'unset/announce',
- '^set/nodx', 'unset/dx', 'unset/dx',
- '^set/nota', 'unset/talk', 'unset/talk',
- '^set/noww', 'unset/wwv', 'unset/wwv',
- '^set/nowx', 'unset/wx', 'unset/wx',
- '^sh$', 'show', 'show',
- '^sh\w*/buck', 'dbshow buck', 'dbshow',
- '^sh\w*/bu', 'show/files bulletins', 'show/files',
- '^sh\w*/c/n', 'show/configuration nodes', 'show/configuration',
- '^sh\w*/c$', 'show/configuration', 'show/configuration',
- '^sh\w*/com', 'dbavail', 'dbavail',
- '^sh\w*/dx/(\d+)-(\d+)', 'show/dx $1-$2', 'show/dx',
- '^sh\w*/dx/(\d+)', 'show/dx $1', 'show/dx',
- '^sh\w*/dx/d(\d+)', 'show/dx from $1', 'show/dx',
- '^sh\w*/email', 'dbshow email', 'dbshow',
- '^sh\w*/hftest', 'dbshow hftest', 'dbshow',
- '^sh\w*/vhftest', 'dbshow vhftest', 'dbshow',
- '^sh\w*/qsl', 'dbshow qsl', 'dbshow',
- '^sh\w*/tnc', 'who', 'who',
- '^sh\w*/up', 'show/cluster', 'show/cluster',
- '^sh\w*/w\w*/(\d+)-(\d+)', 'show/wwv $1-$2', 'show/wwv',
- '^sh\w*/w\w*/(\d+)', 'show/wwv $1', 'show/wwv',
- '^sp$', 'send', 'send',
-
- ],
- 't' => [
- '^ta$', 'talk', 'talk',
- '^t$', 'talk', 'talk',
- ],
- 'u' => [
- ],
- 'v' => [
- ],
- 'w' => [
- '^wx/full', 'wx full', 'wx',
- '^wx/sysop', 'wx sysop', 'wx',
- ],
- 'x' => [
- ],
- 'y' => [
- ],
- 'z' => [
- ],
-)
-</verb></tscreen>
-
-You can create aliases for commands at will. Beware though, these may not always turn out as you think. Care is needed and you need to test the results once you have set an alias.
-
-<sect1>Forward.pl
-
-<P>
-DXSpider receives all and any mail sent to it without any alterations needed
-in files. Because personal and bulletin mail are treated differently, there
-is no need for a list of accepted bulletin addresses. It is necessary, however,
-to tell the program which links accept which bulletins. For example, it is
-pointless sending bulletins addresses to "UK" to any links other than UK
-ones. The file that does this is called forward.pl and lives in /spider/msg.
-At default, like other spider files it is named forward.pl.issue. Rename it
-to forward.pl and edit the file to match your requirements.
-The format is below ...
-
-<tscreen><verb>
-#
-# this is an example message forwarding file for the system
-#
-# The format of each line is as follows
-#
-# type to/from/at pattern action destinations
-# P/B/F T/F/A regex I/F [ call [, call ...] ]
-#
-# type: P - private, B - bulletin (msg), F - file (ak1a bull)
-# to/from/at: T - to field, F - from field, A - home bbs, O - origin
-# pattern: a perl regex on the field requested
-# action: I - ignore, F - forward
-# destinations: a reference to an array containing node callsigns
-#
-# if it is non-private and isn't in here then it won't get forwarded
-#
-# Currently only type B msgs are affected by this code.
-#
-# The list is read from the top down, the first pattern that matches
-# causes the action to be taken.
-#
-# The pattern can be undef or 0 in which case it will always be selected
-# for the action specified
-#
-# If the BBS list is undef or 0 and the action is 'F' (and it matches the
-# pattern) then it will always be forwarded to every node that doesn't have
-# it (I strongly recommend you don't use this unless you REALLY mean it, if
-# you allow a new link with this on EVERY bull will be forwarded immediately
-# on first connection)
-#
-
-package DXMsg;
-
-@forward = (
-'B', 'T', 'LOCAL', 'F', [ qw(GB7MBC) ],
-'B', 'T', 'ALL', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
-'B', 'T', 'UK', 'F', [ qw(GB7BAA GB7ADX) ],
-'B', 'T', 'QSL', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
-'B', 'T', 'QSLINF', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
-'B', 'T', 'DX', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
-'B', 'T', 'DXINFO', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
-'B', 'T', 'DXNEWS', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
-'B', 'T', 'DXQSL', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
-'B', 'T', 'SYSOP', 'F', [ qw(GB7BAA GB7ADX) ],
-'B', 'T', '50MHZ', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
-);
-</verb></tscreen>
-
-Simply insert a bulletin address and state in the brackets where you wish
-that mail to go. For example, you can see here that mail sent to "UK" will
-only be sent to the UK links and not to PA4AB-14.
-
-<P>
-To force the cluster to reread the file use load/forward
-
-<sect1>Distribution lists
-
-<P>
-Distribution lists are simply a list of users to send certain types of
-mail to. An example of this is mail you only wish to send to other
-sysops. In /spider/msg there is a directory called <em>distro</em>. You
-put any distibution lists in here. For example, here is a file called
-SYSOP.pl that caters for the UK sysops.
-
-<tscreen><verb>
-qw(GB7TLH GB7DJK GB7DXM GB7CDX GB7BPQ GB7DXN GB7MBC GB7MBC-6 GB7MDX
- GB7NDX GB7SDX GB7TDX GB7UDX GB7YDX GB7ADX GB7BAA GB7DXA GB7DXH
- GB7DXK GB7DXI GB7DXS)
-</verb></tscreen>
-
-Any mail sent to "sysop" would only be sent to the callsigns in this list.
-
-<sect1>Console.pl
-
-<P>
-In later versions of Spider a simple console program is provided for the sysop. This has a type ahead buffer with line editing facilities and colour for spots, announces etc.
-To use this program, simply use console.pl instead of client.pl.
-
-<P>
-To edit the colours, copy /spider/perl/Console.pl to /spider/local and edit the file with your favourite editor.
-
-<sect>Sysop commands
-
-<P>
-Most maintenance tasks are automatic but there are some commands that are useful for a sysop. These are listed below in alphabetical order. The number in brackets following the command name is the permissions level needed to use the command.
-
-<sect1>announce sysop (5)
-
-<P>
-<tt>
-<bf>announce sysop <text></bf>
-</tt>
-
-<P>
-Send an announcement to Sysops only
-
-<sect1>connect (5)
-
-<P>
-<tt>
-<bf>connect <callsign></bf> Start a connection to another DX Cluster
-</tt>
-
-<P>
-Start a connection process that will culminate in a new connection to the
-DX cluster <callsign>. This process creates a new 'client' process which will
-use the script in /spider/connect/<callsign> to effect the 'chat' exchange
-necessary to traverse the network(s) to logon to the cluster <callsign>.
-
-
-<sect1>catch (9)
-
-<P>
-<tt>
-<bf><node_call> All [<msgno> ...]</bf> Mark a message as sent
-</tt>
-
-<P>
-When you send messages the fact that you have forwarded it to another node
-is remembered so that it isn't sent again. When you have a new partner
-node and you add their callsign to your /spider/msg/forward.pl file, all
-outstanding non-private messages will be forwarded to them. This may well
-be ALL the non-private messages. You can prevent this by using these
-commmands:-
-
- catch GB7DJK all
- catch GB7DJK 300 301 302 303
-
-and to undo what you have just done:-
-
- uncatch GB7DJK all
- uncatch GB7DJK 300 301 302 303
-
-which will arrange for them to be forward candidates again.
-
-<sect1>dbcreate (9)
-
-<P>
-<tt>
-<bf>dbcreate <name></bf> Create a database entry<newline>
-<bf>dbcreate <name> chain <name> [<name>..]</bf> Create a chained database entry<newline>
-<bf>dbcreate <name> remote <node></bf> Create a remote database entry<newline>
-</tt>
-
-<P>
-DBCREATE allows you to define a database in the system. It doesn't actually
-create anything, just defines it.
-
-The databases that are created are simple DB_File hash databases, they are
-therefore already 'indexed'.
-
-You can define a local database with the first form of the command eg:
-
- DBCREATE oblast
-
-You can also chain databases with the addition of the 'chain' keyword.
-This will search each database one after the other. A typical example
-is:
-
- DBCREATE sdx_qsl chain sql_ad
-
-No checking is done to see if the any of the chained databases exist, in
-fact it is usually better to do the above statement first then do each of
-the chained databases.
-
-Databases can exist offsite. To define a database that lives on another
-node do:
-
- DBCREATE buckmaster remote gb7dxc
-
-Remote databases cannot be chained; however, the last database in a
-a chain can be a remote database eg:
-
- DBCREATE qsl chain gb7dxc
-
-To see what databases have been defined do:
-
- DBAVAIL (or it will have been aliased to SHOW/COMMAND)
-
-It would be normal for you to add an entry into your local Aliases file
-to allow people to use the 'SHOW/<dbname>' style syntax. So you would
-need to add a line like:-
-
-<tscreen><verb>
- 's' => [
- ..
- ..
- '^sh\w*/buc', 'dbshow buckmaster', 'dbshow',
- ..
- ..
- ],
-</verb></tscreen>
-
-to allow
-
- SH/BUCK g1tlh
-
-to work as they may be used to.
-
-See DBIMPORT for the importing of existing AK1A format data to databases.
-See DBSHOW for generic database enquiry
-
-<sect1>dbimport (9)
-
-<P>
-<tt>
-<bf>dbimport <dbname></bf> Import AK1A data into a database
-</tt>
-
-<P>
-If you want to import or update data in bulk to a database you can use
-this command. It will either create or update entries into an existing
-database. For example:-
-
- DBIMPORT oblast /tmp/OBLAST.FUL
-
-will import the standard OBLAST database that comes with AK1A into the
-oblast database held locally.
-
-<sect1>dbremove (9)
-
-<P>
-<tt>
-<bf>dbremove <dbname></bf> Delete a database
-</tt>
-
-<P>
-DBREMOVE will completely remove a database entry and also delete any data
-file that is associated with it.
-
-There is no warning, no comeback, no safety net.
-
-For example:
-
- DBREMOVE oblast
-
-will remove the oblast database from the system and it will also remove
-the associated datafile.
-
-I repeat:
-
-There is no warning, no comeback, no safety net.
-
-You have been warned.
-
-<sect1>debug (9)
-
-<P>
-<tt>
-<bf>debug</bf> Set the cluster program into debug mode
-</tt>
-
-<P>
-Executing this command will only have an effect if you are running the cluster
-in debug mode i.e.
-
-<tscreen><verb>
- perl -d cluster.pl
-</verb></tscreen>
-
-It will interrupt the cluster just after the debug command has finished.
-
-<sect1>directory (5)
-
-<P>
-Works just like the user command except that sysops can see ALL messages.
-
-<sect1>disconnect (8)
-
-<P>
-<tt>
-<bf>disconnect <call> [<call> ...]</bf> Disconnect a user or node
-</tt>
-
-<P>
-Disconnect any <call> connected locally
-
-<sect1>export (9)
-
-<P>
-<tt>
-<bf>export <msgno> <filename></bf> Export a message to a file
-</tt>
-
-<P>
-Export a message to a file. This command can only be executed on a local
-console with a fully privileged user. The file produced will be in a form
-ready to be imported back into the cluster by placing it in the import
-directory (/spider/msg/import).
-
-This command cannot overwrite an existing file. This is to provide some
-measure of security. Any files written will owned by the same user as the
-main cluster, otherwise you can put the new files anywhere the cluster can
-access. For example:-
-
- EXPORT 2345 /tmp/a
-
-<sect1>forward/opername (1)
-
-<P>
-<tt>
-<bf>forward/opername <call></bf> Send out information on this <call> to all clusters
-</tt>
-
-<P>
-This command sends out any information held in the user file which can
-be broadcast in PC41 protocol packets. This information is Name, QTH, Location
-and Homenode. PC41s are only sent for the information that is available.
-
-<sect1>init (5)
-
-<P>
-<tt>
-<bf>init <node call></bf> Re-initialise a link to an AK1A compatible node
-</tt>
-
-<P>
-This command attempts to re-initialise a link to a (usually) AK1A node
-that has got confused, usually by a protocol loop of some kind. It may
-work - but you usually will be better off simply disconnecting it (or
-better, if it is a real AK1A node, doing an RCMD <node> DISC/F <your
-node>).
-
-Best of luck - you will need it.
-
-<sect1>kill (5)
-
-<P>
-<tt>
-<bf>kill <msgno> [<msgno> ...]</bf> Remove or erase a message from the system<newline>
-<bf>kill from <call></bf> Remove all messages from a callsign<newline>
-<bf>kill to <call></bf> Remove all messages to a callsign<newline>
-</tt>
-
-<P>
-You can get rid of any message to or originating from your callsign using
-this command. You can remove more than one message at a time.
-
-As a sysop you can kill any message on the system.
-
-<sect1>kill full (5)
-
-<tt>
-<bf>kill full <msgno> [<msgno>]</bf> Delete a message from the whole cluster
-</tt>
-
-<P>
-Delete a message (usually a 'bulletin') from the whole cluster system.
-
-This uses the subject field, so any messages that have exactly the same subject
-will be deleted. Beware!
-
-<sect1>load/aliases (9)
-
-<P>
-<tt>
-<bf>load/aliases</bf> Reload the command alias table
-</tt>
-
-<P>
-Reload the /spider/cmd/Aliases file after you have editted it. You will need to
-do this if you change this file whilst the cluster is running in order for the
-changes to take effect.
-
-<sect1>load/bands (9)
-
-<P>
-<tt>
-<bf>load/bands</bf> Reload the band limits table
-</tt>
-
-<P>
-Reload the /spider/data/bands.pl file if you have changed it manually whilst
-the cluster is running.
-
-<sect1>load/cmd_cache (9)
-
-<P>
-<tt>
-<bf>load/cmd_cache</bf> Reload the automatic command cache
-</tt>
-
-<P>
-Normally, if you change a command file in the cmd or local_cmd tree it will
-automatially be picked up by the cluster program. Sometimes it can get confused
-if you are doing a lot of moving commands about or delete a command in the
-local_cmd tree and want to use the normal one again. Execute this command to
-reset everything back to the state it was just after a cluster restart.
-
-<sect1>load/messages (9)
-
-<P>
-<tt>
-<bf>load/messages</bf> Reload the system messages file
-</tt>
-
-<P>
-If you change the /spider/perl/Messages file (usually whilst fiddling/writing ne
-commands) you can have them take effect during a cluster session by executing this
-command. You need to do this if get something like :-
-
-unknown message 'xxxx' in lang 'en'
-
-<sect1>load/prefixes (9)
-
-<P>
-<tt>
-<bf>load/prefixes</bf> Reload the prefix table
-</tt>
-
-<P>
-Reload the /spider/data/prefix_data.pl file if you have changed it manually whilst
-the cluster is running.
-
-<sect1>merge (5)
-
-<P>
-<tt>
-<bf>merge <node> [<no spots>/<no wwv>]</bf> Ask for the latest spots and WWV
-</tt>
-
-<P>
-MERGE allows you to bring your spot and wwv database up to date. By default
-it will request the last 10 spots and 5 WWVs from the node you select. The
-node must be connected locally.
-
-You can request any number of spots or wwv and although they will be appended
-to your databases they will not duplicate any that have recently been added
-(the last 2 days for spots and last month for WWV data).
-
-<sect1>msg (9)
-
-<P>
-<tt>
-<bf>msg <cmd> <msgno> [data ...]</bf> Alter various message parameters
-</tt>
-
-<P>
-Alter message parameters like To, From, Subject, whether private or bulletin
-or return receipt (RR) is required or whether to keep this message from timing
-out.
-
-<tscreen><verb>
- MSG TO <msgno> <call> - change TO callsign to <call>
- MSG FRom <msgno> <call> - change FROM callsign to <call>
- MSG PRrivate <msgno> - set private flag
- MSG NOPRrivate <msgno> - unset private flag
- MSG RR <msgno> - set RR flag
- MSG NORR <msgno> - unset RR flag
- MSG KEep <msgno> - set the keep flag (message won't be deleted ever)
- MSG NOKEep <msgno> - unset the keep flag
- MSG SUbject <msgno> <new> - change the subject to <new>
- MSG WAittime <msgno> - remove any waitting time for this message
- MSG NOREad <msgno> - mark message as unread
- MSG REad <msgno> - mark message as read
- MSG QUeue - queue any outstanding bulletins
- MSG QUeue 1 - queue any outstanding private messages
-</verb></tscreen>
-
-You can look at the status of a message by using:-
-
- STAT/MSG <msgno>
-
-This will display more information on the message than DIR does.
-
-<sect1>pc (8)
-
-<P>
-<tt>
-<bf>pc <call> <text></bf> Send text (eg PC Protocol) to <call>
-</tt>
-
-<P>
-Send some arbitrary text to a locally connected callsign. No processing is done on
-the text. This command allows you to send PC Protocol to unstick things if problems
-arise (messages get stuck etc). eg:-
-
- pc gb7djk PC33^GB7TLH^GB7DJK^400^
-
-You can also use in the same way as a talk command to a connected user but
-without any processing, added of "from <blah> to <blah>" or whatever.
-
- pc G1TLH Try doing that properly!!!
-
-<sect1>ping (1)
-
-<P>
-<tt>
-<bf>ping <node></bf> Send a ping command to another cluster node
-</tt>
-
-<P>
-This command is used to estimate the quality of the link to another cluster.
-The time returned is the length of time taken for a PC51 to go to another
-cluster and be returned.
-
-Any visible cluster node can be PINGed.
-
-<sect1>rcmd (1)
-
-<P>
-<tt>
-<bf>rcmd <node call> <cmd></bf> Send a command to another DX cluster
-</tt>
-
-<P>
-This command allows you to send nearly any command to another DX Cluster
-node that is connected to the system.
-
-Whether you get any output is dependant on a) whether the other system knows
-that the node callsign of this cluster is in fact a node b) whether the
-other system is allowing RCMDs from this node and c) whether you have
-permission to send this command at all.
-
-<sect1>read (5)
-
-<P>
-<tt>
-<bf>read <msgno></bf> Read a message on the system
-</tt>
-
-<P>
-As a sysop you may read any message on the system
-
-<sect1>set/debug (9)
-
-<P>
-<tt>
-<bf>set/debug <name></bf> Add a debug level to the debug set
-</tt>
-
-<P>
-You can remove this level with unset/debug <name>
-
-<sect1>set/isolate (9)
-
-<P>
-<tt>
-<bf>set/isolate <node call></bf> Isolate a node from the rest of the network
-</tt>
-
-<P>
-Connect a node to your system in such a way that you are a full protocol
-member of its network and can see all spots on it, but nothing either leaks
-out from it nor goes back into from the rest of the nodes connected to you.
-
-You can potentially connect several nodes in this way.
-
-You can see which nodes are isolated with the show/isolate (1) command.
-
-You can remove the isolation with the command unset/isolate.
-
-<sect1>set/sys_location (9)
-
-<P>
-<tt>
-<bf>set/sys_location <lat & long></bf> Set your cluster latitude and longitude
-</tt>
-
-<P>
-In order to get accurate headings and such like you must tell the system
-what your latitude and longitude is. If you have not yet done a SET/QRA
-then this command will set your QRA locator for you. For example:-
-
- SET/LOCATION 52 22 N 0 57 E
-
-<sect1>set/lockout (9)
-
-<P>
-<tt>
-<bf>set/lockout <call></bf> Stop a callsign connecting to the cluster
-</tt>
-
-<P>
-You can show who is locked out with the show/lockout (9) command.
-
-To allow the user to connect again, use the command unset/lockout
-
-<sect1>set/node (9)
-
-<P>
-<tt>
-<bf>set/node <call> [<call> ...]</bf> Make the callsign an AK1A cluster
-</tt>
-
-<P>
-Tell the system that the call(s) are to be treated as AK1A cluster and
-fed PC Protocol rather normal user commands.
-
-From version 1.41 you can also set the following types of cluster
-
-<verb>
-set/spider
-set/dxnet
-set/clx
-set/arcluster
-</verb>
-
-To see what your nodes are set to, use the show/nodes command.
-
-<sect1>set/obscount (9)
-
-<P>
-<tt>
-<bf>set/obscount <count> <node call></bf> Set the 'pump-up' obscelence counter
-</tt>
-
-<P>
-From version 1.35 onwards neighbouring nodes are pinged at regular intervals (see
-SET/PINGINTERVAL), usually 300 seconds or 5 minutes. There is a 'pump-up'
-counter which is decremented on every outgoing ping and then reset to
-the 'obscount' value on every incoming ping. The default value of this
-parameter is 2.
-
-What this means is that a neighbouring node will be pinged twice at
-(default) 300 second intervals and if no reply has been heard just before
-what would be the third attempt, that node is disconnected.
-
-If a ping is heard then the obscount is reset to the full value. Using
-default values, if a node has not responded to a ping within 15 minutes,
-it is disconnected.
-
-<sect1>set/pinginterval (9)
-
-<P>
-<tt>
-<bf>set/pinginterval <time> <node call></bf> Set the ping time to neighbouring nodes
-</tt>
-
-<P>
-As from version 1.35 all neighbouring nodes are pinged at regular intervals
-in order to determine the rolling quality of the link and, in future, to
-affect routing decisions. The default interval is 300 secs or 5 minutes.
-
-You can use this command to set a different interval. Please don't.
-
-But if you do the value you enter is treated as minutes up 60 and seconds
-for numbers greater than that.
-
-This is used also to help determine when a link is down at the far end
-(as certain cluster software doesn't always notice), see SET/OBSCOUNT
-for more information.
-
-<sect1>set/privilege (9)
-
-<P>
-<tt>
-<bf>set/privilege <n> <call> [<call> ...]</bf> Set the privilege level on a call
-</tt>
-
-<P>
-Set the privilege level on a callsign. The privilege levels that pertain
-to commands are as default:-
-
-<tscreen><verb>
- 0 - normal user
- 1 - allow remote nodes normal user RCMDs
- 5 - various privileged commands (including shutdown, but not disc-
- connect), the normal level for another node.
- 8 - more privileged commands (including disconnect)
- 9 - local sysop privilege. DO NOT SET ANY REMOTE USER OR NODE TO THIS
- LEVEL.
-</verb></tscreen>
-
-If you are a sysop and you come in as a normal user on a remote connection
-your privilege will automatically be set to 0.
-
-<sect1>set/password (9)
-
-<P>
-<tt>
-<bf>set/password <callsign> <string></bf> Set a users password
-</tt>
-
-<P>
-The password for a user can only be set by a full sysop. The string
-can contain any characters but any spaces are removed (you can type in
-spaces - but they won't appear in the password). You can see the
-result with STAT/USER. The password is the usual 30 character baycom
-type password.
-
-<sect1>set/sys_qra (9)
-
-<P>
-<tt>
-<bf>set/sys_qra <locator></bf> Set your cluster QRA locator
-</tt>
-
-<sect1>show program (5)
-
-<P>
-<tt>
-<bf>show/program</bf> Show the locations of all the included program modules
-</tt>
-
-<P>
-Show the name and location where every program module was load from. This
-is useful for checking where you think you have loaded a .pm file from.
-
-<sect1>shutdown (5)
-
-<P>
-<tt>
-<bf>shutdown</bf> Shutdown the cluster
-</tt>
-
-<P>
-Shutdown the cluster and disconnect all the users. If you have Spider
-set to respawn in /etc/inittab it will of course restart.
-
-<sect1>spoof (9)
-
-<P>
-<tt>
-<bf>spoof <callsign> <command></bf> Run commands as another user
-</tt>
-
-<P>
-This is a very simple yet powerful command for the sysop. It allows you to
-issue commands as if you were a different user. This is very useful for the
-kind of things that users seem to always get wrong.. like home_node for
-example.
-
-<sect1>stat/db (5)
-
-<P>
-<tt>
-<bf>stat/db <dbname></bf> Show the status of a database
-</tt>
-
-<P>
-Show the internal status of a database descriptor.
-
-Depending on your privilege level you will see more or less information.
-This command is unlikely to be of much use to anyone other than a sysop.
-
-<sect1>stat/channel (5)
-
-<P>
-<tt>
-<bf>stat/channel <callsign></bf> Show the status of a channel on the cluster
-</tt>
-
-<P>
-Show the internal status of the channel object either for the channel that
-you are on or else for the callsign that you asked for.
-
-Only the fields that are defined (in perl term) will be displayed.
-
-<sect1>stat/msg (5)
-
-<P>
-<tt>
-<bf>stat/msg <msgno></bf> Show the status of a message
-</tt>
-
-<P>
-This command shows the internal status of a message and includes information
-such as to whom it has been forwarded, its size, origin etc etc.
-
-<sect1>stat/user (5)
-
-<P>
-<tt>
-<bf>stat/user <callsign></bf> Show the full status of a user
-</tt>
-
-<P>
-Shows the full contents of a user record including all the secret flags
-and stuff.
-
-Only the fields that are defined (in perl term) will be displayed.
-
-
-
-</article>
+<!doctype linuxdoc system>\r
+\r
+<article>\r
+\r
+<!-- Title information -->\r
+\r
+<title>The DXSpider Administration Manual v1.51</title> \r
+<author>Ian Maude, G0VGS, (g0vgs@gb7mbc.net), and\r
+Charlie Carroll, K1XX, (k1xx@ptcnh.net)</author>\r
+<date>June 2004 revision 1</date>\r
+\r
+<abstract>\r
+A reference for SysOps of the DXSpider DXCluster program.\r
+</abstract>\r
+\r
+<!-- Table of contents -->\r
+<toc>\r
+\r
+<!-- Begin the document -->\r
+\r
+<sect>Routing and Filtering\r
+\r
+<sect1>Introduction\r
+\r
+<P>\r
+From DXSpider version 1.48, major changes were introduced to the way \r
+node connections are treated. This is part of an ongoing process to\r
+remove problems with loops and to enable talk and other functions to\r
+propagate across the whole of the worldwide cluster network. In fact,\r
+in a Spider network, it would be useful, perhaps even necessary to\r
+have loops. This would give real resilience to the network, meaning\r
+that if a link dropped, the information flow would simply come in and\r
+go out via a different route. Of course, we do not have a complete\r
+network of Spider nodes, there are other programs out there. Some of\r
+these do not have any protection from loops. Certainly AK1A does not \r
+handle loops well at all. It is therefore necessary to have some form \r
+of protection for these nodes.\r
+\r
+<P>\r
+In fact DXSpider has had a simple system for some time which is called\r
+<it>isolation</it>. This is similar to what in other systems such as \r
+<bf>clx</bf>, is called <it>passive mode</it>. A more detailed explanation\r
+of <it>isolation</it> is given further below. This system is still available\r
+and, for simple networks, is probably all that you need.\r
+\r
+<P>\r
+The new functionality introduced in version 1.48 allows filtering the node\r
+and user protocol frames on a "per interface" basis. We call this\r
+<it>route filtering</it>. This is used <bf>instead of</bf>\r
+<it>isolation</it>. \r
+\r
+<p>\r
+What this really means is that you can control more or less completely\r
+which user and node management PC protocol frames pass to each of your \r
+partner nodes. You can also limit what comes into your node from your \r
+partners. It is even possible to control the settings that your partner \r
+node has for the routing information that it sends to you \r
+(using the <it>rcmd</it> command).\r
+\r
+<sect1>Route Filters\r
+\r
+<p>\r
+Initially when route filters were being tested we generated a\r
+"default" filter. Unfortunately it quickly became apparent that this\r
+might suit the UK cluster network but didn't really fit anybody else.\r
+However using a default filter is an appropriate thing to do. How, is\r
+explained further on.\r
+\r
+<p>\r
+The first thing that you must do is determine whether you need to use \r
+route filtering <bf>at all</bf>. If you are a "normal" node with two or \r
+three partners and you arranged in an "official" non-looping tree type \r
+network, then <bf>you do not need to do route filtering</bf> and you will \r
+feel a lot better for not getting involved. If you are successfully using \r
+<it>isolation</it> then you also probably don't need to use route filtering.\r
+\r
+<p>\r
+To put it simply, you should not mix Isolation and Route Filtering. It \r
+will work, of sorts, but you will not get the expected results. If you \r
+are using Isolation sucessfully at the moment, do not get involved in \r
+Route Filtering unless you have a good supply of aspirin! Once you have \r
+started down the road of Route Filtering, do not use Isolation either.\r
+Use one or the other, not both.\r
+\r
+<p>\r
+You will only require this functionality if you are "well-connected". What \r
+that means is that you are connected to several different parts of (say) \r
+the EU cluster and, at the same time, also connected to two or three places \r
+in the US which, in turn are connected back to the EU. This is called a \r
+"loop" and if you are seriously looped then you need filtering.\r
+\r
+<P>\r
+I should at this stage give a little bit of background on filters. All\r
+the filters in Spider work in basically the same way. You can either\r
+accept or reject various options in order to create the filter rules\r
+you wish to achieve. Some filters are user settable, others can only\r
+be altered by the sysop. Route filtering can only be done by the sysop.\r
+\r
+<P> \r
+Anyway, without further discouragement, let me start the process\r
+of explanation.\r
+\r
+<sect1>The node_default filter\r
+\r
+<P>\r
+All normal systems should have a default routing filter and it should\r
+usually be set to send only the normal, unlooped, view of your\r
+"national" network. Here in the UK that means nodes from the UK and\r
+Eire, in EU it is more complex as the networks there grew up in a more\r
+intertwined way.\r
+\r
+<p> \r
+The generic commands are:-\r
+\r
+<tscreen><verb>\r
+reject/route node_default <filter_option>\r
+\r
+or\r
+\r
+accept/route node_default <filter_option>\r
+</verb></tscreen>\r
+\r
+where filter_option is one of the following ...\r
+\r
+<tscreen><verb>\r
+call <prefixes>\r
+call_dxcc <numbers>\r
+call_itu <numbers>\r
+call_zone <numbers>\r
+channel <prefixes>\r
+channel_dxcc <numbers>\r
+channel_itu <numbers>\r
+channel_zone <numbers>\r
+</verb></tscreen>\r
+\r
+Please be careful if you alter this setting, it will affect \r
+<bf><it>ALL</it></bf> your links! Remember, this is a <it>default</it>\r
+filter for node connections, not a <it>per link</it> default.\r
+\r
+<p>\r
+For the default routing filter then you have two real choices: either\r
+a "national" view or the "safe" option of only your own\r
+callsign. Examples of each (for my node: GB7DJK) are:-\r
+\r
+<tscreen><verb>\r
+acc/route node_default call_dxcc 61,38\r
+acc/route node_default call gb7djk\r
+</verb></tscreen>\r
+\r
+GB7DJK uses the first of these. The DXCC countries can be obtained from the \r
+<it>show/prefix</it> command.\r
+\r
+<p>\r
+The example filters shown control <it>output</it> <bf>TO</bf> all your\r
+partner nodes unless they have a specific filter applied to them (see\r
+next section).\r
+\r
+<p>\r
+It is also possible to control the <it>incoming</it> routing\r
+information that you are prepared to accept <bf>FROM</bf> your partner\r
+nodes. The reason this is necessary is to make sure that stuff like\r
+mail, pings and similar commands a) go down the correct links and b)\r
+don't loop around excessively. Again using GB7DJK as an example a typical\r
+default input filter would be something like:\r
+\r
+<tscreen><verb>\r
+rej/route node_default input call_dxcc 61,38 and not channel_dxcc 61,38\r
+</verb></tscreen>\r
+\r
+What this does is accept node and user information for our national\r
+network from nodes that are in our national network, but rejects such\r
+information from anyone else. Although it doesn't explicitly say so,\r
+by implication, any other node information (not from the UK and Eire)\r
+is accepted.\r
+\r
+<p>\r
+As I imagine it will take a little while to get one's head around all of \r
+this you can study the effect of any rules that you try by watching the \r
+debug output after having done:-\r
+\r
+<tscreen><verb>\r
+set/debug filter\r
+</verb></tscreen>\r
+\r
+After you have got tired of that, to put it back the way it was:-\r
+\r
+<tscreen><verb>\r
+unset/debug filter\r
+</verb></tscreen>\r
+\r
+<sect1>General route filtering\r
+\r
+<P>\r
+Exactly the same rules apply for general route filtering. You would\r
+use either an accept filter or a reject filter like this ...\r
+\r
+<tscreen><verb>\r
+reject/route <node_call> <filter_option>\r
+\r
+or\r
+\r
+accept/route <node_call> <filter_option> \r
+</verb></tscreen>\r
+\r
+<P>\r
+Here are some examples of route filters ...\r
+\r
+<tscreen><verb>\r
+rej/route gb7djk call_dxcc 61,38 (send everything except UK+EIRE nodes)\r
+rej/route all (equiv to [very] restricted mode)\r
+acc/route gb7djk call_dxcc 61,38 (send only UK+EIRE nodes)\r
+acc/route gb7djk call gb7djk (equiv to SET/ISOLATE)\r
+</verb></tscreen>\r
+\r
+In practice you will either be opening the default filter out for a\r
+partner by defining a specific filter for that callsign:-\r
+ \r
+<tscreen><verb>\r
+acc/route gb7baa all\r
+acc/route gb7baa input all\r
+</verb></tscreen>\r
+\r
+or restricting it quite a lot, in fact making it very nearly like an \r
+<it>isolated</it> node, like this:-\r
+\r
+<tscreen><verb>\r
+acc/route pi4ehv-8 call gb7djk\r
+rej/route pi4ehv-8 input call_dxcc 61,38 \r
+</verb></tscreen>\r
+\r
+This last example takes everything except UK and Eire from PI4EHV-8\r
+but only sends him my local configuration (just a PC19 for GB7DJK and\r
+PC16s for my local users).\r
+\r
+<p>\r
+It is possible to write <bf>much</bf> more complex rules, there are up \r
+to 10 accept/reject pairs per callsign per filter. For more information \r
+see the next section. \r
+\r
+\r
+<sect1>General filter rules\r
+\r
+<P>\r
+Upto v1.44 it was not possible for the user to set their own filters. From \r
+v1.45 though that has all changed. It is now possible to set filters for just \r
+about anything you wish. If you have just updated from an older version of \r
+DXSpider you will need to update your new filters. You do not need to do \r
+anything with your old filters, they will be renamed as you update.\r
+\r
+<P>\r
+There are 3 basic commands involved in setting and manipulating filters. These \r
+are <em>accept</em>, <em>reject</em> and <em>clear</em>. First we will look\r
+generally at filtering. There are a number of things you can filter in the \r
+DXSpider system. They all use the same general mechanism.\r
+\r
+<P>\r
+In general terms you can create a "reject" or an "accept" filter which can have \r
+up to 10 lines in it. You do this using, for example ... \r
+\r
+<tscreen><verb> \r
+accept/spots .....\r
+reject/spots .....\r
+</verb></tscreen>\r
+\r
+where ..... are the specific commands for that type of filter. There are filters \r
+for spots, wwv, announce, wcy and (for sysops) connects. See each different \r
+accept or reject command reference for more details.\r
+\r
+There is also a command to clear out one or more lines in a filter. They are ...\r
+\r
+<tscreen><verb>\r
+clear/spots 1\r
+clear/spots all\r
+</verb></tscreen>\r
+\r
+There is clear/xxxx command for each type of filter.\r
+\r
+<P>\r
+and you can check that your filters have worked by the command ... \r
+\r
+<tscreen><verb> \r
+show/filter\r
+</verb></tscreen>\r
+\r
+<P>\r
+For now we are going to use spots for the examples, but you can apply the same\r
+principles to all types of filter.\r
+\r
+<sect1>Types of filter\r
+\r
+<P>\r
+There are two main types of filter, <em>accept</em> or <em>reject</em>. You \r
+can use either to achieve the result you want dependent on your own preference \r
+and which is more simple to do. It is pointless writing 8 lines of reject \r
+filters when 1 accept filter would do the same thing! Each filter has 10 \r
+lines (of any length) which are tried in order. If a line matches then the \r
+action you have specified is taken (ie reject means ignore it and accept \r
+means take it)\r
+\r
+<P>\r
+If you specify reject filters, then any lines that arrive that match the filter \r
+will be dumped but all else will be accepted. If you use an accept filter, \r
+then ONLY the lines in the filter will be accepted and all else will be dumped.\r
+For example if you have a single line <em>accept</em> filter ...\r
+\r
+<tscreen><verb>\r
+accept/spots on vhf and (by_zone 14,15,16 or call_zone 14,15,16)\r
+</verb></tscreen>\r
+\r
+then you will <em>ONLY</em> get VHF spots <em>from</em> or <em>to</em> CQ zones \r
+14, 15 and 16.\r
+\r
+<P>\r
+If you set a reject filter like this ...\r
+\r
+<tscreen><verb>\r
+reject/spots on hf/cw\r
+</verb></tscreen>\r
+\r
+Then you will get everything <em>EXCEPT</em> HF CW spots. You could make this \r
+single filter even more flexible. For example, if you are interested in IOTA \r
+and will work it even on CW even though normally you are not interested in \r
+CW, then you could say ...\r
+\r
+<tscreen><verb>\r
+reject/spots on hf/cw and not info iota\r
+</verb></tscreen>\r
+\r
+But in that case you might only be interested in iota and say:-\r
+\r
+<tscreen><verb>\r
+accept/spots not on hf/cw or info iota\r
+</verb></tscreen>\r
+\r
+which achieves exactly the same thing. You should choose one or the other \r
+until you are comfortable with the way it works. You can mix them if you \r
+wish (actually you can have an accept AND a reject on the same line) but \r
+don't attempt this until you are sure you know what you are doing!\r
+\r
+<P>\r
+You can arrange your filter lines into logical units, either for your own\r
+understanding or simply convenience. Here is an example ...\r
+\r
+<tscreen><verb>\r
+reject/spots 1 on hf/cw\r
+reject/spots 2 on 50000/1400000 not (by_zone 14,15,16 or call_zone 14,15,16) \r
+</verb></tscreen>\r
+\r
+What this does is to ignore all HF CW spots and also rejects any spots on VHF \r
+which don't either originate or spot someone in Europe. \r
+\r
+<P>\r
+This is an example where you would use a line number (1 and 2 in this case), if \r
+you leave the digit out, the system assumes '1'. Digits '0'-'9' are available. \r
+This make it easier to see just what filters you have set. It also makes it \r
+more simple to remove individual filters, during a contest for example.\r
+\r
+<P>\r
+You will notice in the above example that the second line has brackets. Look \r
+at the line logically. You can see there are 2 separate sections to it. We \r
+are saying reject spots that are VHF or above <em>APART</em> from those in \r
+zones 14, 15 and 16 (either spotted there or originated there). If you did \r
+not have the brackets to separate the 2 sections, then Spider would read it \r
+logically from the front and see a different expression entirely ...\r
+\r
+<tscreen><verb>\r
+(on 50000/1400000 and by_zone 14,15,16) or call_zone 14,15,16 \r
+</verb></tscreen>\r
+\r
+The simple way to remember this is, if you use OR - use brackets. Whilst we are \r
+here CASE is not important. 'And BY_Zone' is just the same as 'and by_zone'.\r
+\r
+As mentioned earlier, setting several filters can be more flexible than \r
+simply setting one complex one. Doing it in this way means that if you want \r
+to alter your filter you can just redefine or remove one or more lines of it or \r
+one line. For example ...\r
+\r
+<tscreen><verb>\r
+reject/spots 1 on hf/ssb\r
+</verb></tscreen>\r
+\r
+would redefine our earlier example, or \r
+\r
+<tscreen><verb>\r
+clear/spots 1\r
+</verb></tscreen>\r
+\r
+To remove all the filter lines in the spot filter ...\r
+\r
+<tscreen><verb>\r
+clear/spots all\r
+</verb></tscreen>\r
+\r
+<sect1>Filter options\r
+\r
+<P>\r
+You can filter in several different ways. The options are listed in the\r
+various helpfiles for accept, reject and filter.\r
+\r
+<sect1>Default filters\r
+\r
+<P>\r
+Sometimes all that is needed is a general rule for node connects. This can\r
+be done with a node_default filter. This rule will always be followed, even\r
+if the link is isolated, unless another filter is set specifically. Default\r
+rules can be set for nodes and users. They can be set for spots, announces,\r
+WWV and WCY. They can also be used for hops. An example might look like \r
+this ...\r
+\r
+<tscreen><verb>\r
+accept/spot node_default by_zone 14,15,16,20,33\r
+set/hops node_default spot 50\r
+</verb></tscreen>\r
+\r
+This filter is for spots only, you could set others for announce, WWV and WCY.\r
+This filter would work for ALL nodes unless a specific filter is written to \r
+override it for a particular node. You can also set a user_default should\r
+you require. It is important to note that default filters should be\r
+considered to be "connected". By this I mean that should you override the\r
+default filter for spots, you need to add a rule for the hops for spots also.\r
+\r
+<sect1>Advanced filtering\r
+\r
+<P>\r
+Once you are happy with the results you get, you may like to experiment. \r
+\r
+<P>\r
+The previous example that filters hf/cw spots and accepts vhf/uhf spots from EU \r
+can be written with a mixed filter, for example ... \r
+\r
+<tscreen><verb>\r
+rej/spot on hf/cw\r
+acc/spot on 0/30000\r
+acc/spot 2 on 50000/1400000 and (by_zone 14,15,16 or call_zone 14,15,16)\r
+</verb></tscreen>\r
+\r
+Note that the first filter has not been specified with a number. This will \r
+automatically be assumed to be number 1. In this case, we have said <em>reject all\r
+HF spots in the CW section of the bands but accept all others at HF. Also\r
+accept anything in VHF and above spotted in or by operators in the zones\r
+14, 15 and 16</em>. Each filter slot actually has a 'reject' slot and \r
+an 'accept' slot. The reject slot is executed BEFORE the accept slot.\r
+\r
+<P>\r
+It was mentioned earlier that after a reject test that doesn't match, the default \r
+for following tests is 'accept', the reverse is true for 'accept'. In the example \r
+what happens is that the reject is executed first, any non hf/cw spot is passed \r
+to the accept line, which lets through everything else on HF. The next filter line \r
+lets through just VHF/UHF spots from EU.\r
+\r
+<sect1>Basic hop control\r
+\r
+<P>\r
+In /spider/data you will find a file called hop_table.pl. This is the file \r
+that controls your hop count settings. It has a set of default hops on the \r
+various PC frames and also a set for each node you want to alter the hops for. \r
+You may be happy with the default settings of course, but this powerful tool \r
+can help to protect and improve the network. The file will look something \r
+like this ...\r
+\r
+<tscreen><verb>\r
+# \r
+# hop table construction\r
+# \r
+\r
+package DXProt;\r
+\r
+# default hopcount to use\r
+$def_hopcount = 5;\r
+\r
+# some variable hop counts based on message type\r
+%hopcount = \r
+(\r
+ 11 => 10,\r
+ 16 => 10,\r
+ 17 => 10,\r
+ 19 => 10,\r
+ 21 => 10,\r
+);\r
+\r
+\r
+# the per node hop control thingy\r
+\r
+\r
+%nodehops = \r
+(\r
+ GB7ADX => { 11 => 8,\r
+ 12 => 8,\r
+ 16 => 8,\r
+ 17 => 8,\r
+ 19 => 8,\r
+ 21 => 8,\r
+ },\r
+\r
+ GB7UDX => { 11 => 8,\r
+ 12 => 8,\r
+ 16 => 8,\r
+ 17 => 8,\r
+ 19 => 8,\r
+ 21 => 8,\r
+ },\r
+ GB7BAA => {\r
+ 11 => 5,\r
+ 12 => 8,\r
+ 16 => 8,\r
+ 17 => 8,\r
+ 19 => 8,\r
+ 21 => 8,\r
+ },\r
+);\r
+</verb></tscreen>\r
+\r
+<P>\r
+Each set of hops is contained within a pair of curly braces and contains a \r
+series of PC frame types. PC11 for example is a DX spot. The figures here \r
+are not exhaustive but should give you a good idea of how the file works.\r
+\r
+<P>\r
+SHould any of the nodecalls include an ssid, it is important to wrap the\r
+whole call in single quotes, like this ...\r
+\r
+<tscreen><verb>\r
+ 'DB0FHF-15' => {\r
+ 11 => 5,\r
+ 12 => 8,\r
+ 16 => 8,\r
+ 17 => 8,\r
+ 19 => 8,\r
+ 21 => 8,\r
+ },\r
+</verb></tscreen>\r
+\r
+If you do not do this, you will get errors and the file will not work as\r
+expected.\r
+\r
+<P>\r
+You can alter this file at any time, including whilst the cluster is running. \r
+If you alter the file during runtime, the command <em>load/hops</em> will \r
+bring your changes into effect.\r
+\r
+<sect1>Hop Control on Specific Nodes\r
+\r
+<p>You can set a callsign specific hop count for any of the standard filter\r
+options so:-\r
+\r
+<tscreen><verb>\r
+set/hops gb7djk spot 4\r
+set/hops node_default route 10\r
+set/hops gb7baa wcy 5\r
+</verb></tscreen>\r
+ \r
+all work on their specific area of the protocol.\r
+\r
+<p>\r
+The <em>set/hops</em> command overrides any hops that you have set otherwise.\r
+\r
+<p>\r
+You can show what hops have been set using the <em>show/hops</em> command.\r
+\r
+<sect1>Isolating networks\r
+\r
+<P>\r
+It is possible to isolate networks from each other on a "gateway" node using the\r
+ <em>set/isolate <node_call></em> command.\r
+ \r
+<P>\r
+The effect of this is to partition an isolated network completely from another \r
+node connected to your node. Your node will appear on and otherwise behave \r
+normally on every network to which you are connected, but data from an isolated \r
+network will not cross onto any other network or vice versa. However all the \r
+spot, announce and WWV traffic and personal messages will still be handled \r
+locally (because you are a real node on all connected networks), that is locally\r
+connected users will appear on all networks and will be able to access and \r
+receive information from all networks transparently. All routed messages will \r
+be sent as normal, so if a user on one network knows that you are a gateway for \r
+another network, he can still still send a talk/announce etc message via your \r
+node and it will be routed across.\r
+\r
+<P>\r
+If you use isolate on a node connection you will continue to receive\r
+all information from the isolated partner, however you will not pass\r
+any information back to the isolated node. There are times when you\r
+would like to forward only spots across a link (maybe during a contest\r
+for example). To do this, isolate the node in the normal way and use\r
+an <em>acc/spot >call< all</em> filter to override the isolate. \r
+\r
+<sect1>A DXSpider Filtering Tutorial\r
+\r
+<P>\r
+There is now an excellent primer/tutorial on filtering written by Jim\r
+Samuels, W3BG with an introduction by Dave Hawes N3RD that I strongly\r
+suggest you read. You can read it here \r
+<htmlurl url="filtering_en.html" name="The DXSpider User Filtering Primer">\r
+\r
+<sect>Other filters\r
+\r
+<sect1>Filtering Mail\r
+\r
+<P>\r
+In the /spider/msg directory you will find a file called badmsg.pl.issue. Rename\r
+this to badmsg.pl and edit the file. The original looks something like this ....\r
+\r
+<tscreen><verb>\r
+\r
+# the list of regexes for messages that we won't store having\r
+# received them (bear in mind that we must receive them fully before\r
+# we can bin them)\r
+\r
+\r
+# The format of each line is as follows\r
+\r
+# type source pattern \r
+# P/B/F T/F/O/S regex \r
+\r
+# type: P - private, B - bulletin (msg), F - file (ak1a bull)\r
+# source: T - to field, F - from field, O - origin, S - subject \r
+# pattern: a perl regex on the field requested\r
+\r
+# Currently only type B and P msgs are affected by this code.\r
+# \r
+# The list is read from the top down, the first pattern that matches\r
+# causes the action to be taken.\r
+\r
+# The pattern can be undef or 0 in which case it will always be selected\r
+# for the action specified\r
+\r
+\r
+\r
+package DXMsg;\r
+\r
+@badmsg = (\r
+'B', 'T', 'SALE', \r
+'B', 'T', 'WANTED',\r
+'B', 'S', 'WANTED',\r
+'B', 'S', 'SALE', \r
+'B', 'S', 'WTB',\r
+'B', 'S', 'WTS',\r
+'B', 'T', 'FS',\r
+);\r
+</verb></tscreen>\r
+\r
+<P>\r
+I think this is fairly self explanatory. It is simply a list of subject \r
+headers that we do not want to pass on to either the users of the cluster or \r
+the other cluster nodes that we are linked to. This is usually because of \r
+rules and regulations pertaining to items for sale etc in a particular country.\r
+\r
+\r
+<sect1>Filtering words from text fields in Announce, Talk and DX spots\r
+\r
+<p>\r
+From version 1.48 onwards the interface to this has changed. You can now\r
+use the commands <em>set/badword</em> to add words that you are not prepared\r
+to see on the cluster, <em>unset/badword</em> to allow that word again and \r
+<em>show/badword</em> to list the words that you have set.\r
+\r
+<p>\r
+If you have a previous <em>/spider/data/badwords</em>, the first time you start\r
+the node, it will read and convert this file to the new commands. The old style\r
+file will then be removed.\r
+\r
+<sect1>Stopping (possibly bad) DX Spots from Nodes or Spotters\r
+\r
+<p> \r
+There are a number of commands that control whether a spot progresses\r
+any further by regarding it as "bad" in some way.\r
+\r
+<p>\r
+A DX Spot has a number of fields which can be checked to see whether they\r
+contain "bad" values, they are: the DX callsign itself, the Spotter and\r
+the Originating Node.\r
+\r
+<p>\r
+There are a set of commands which allow the sysop to control whether a\r
+spot continues:-\r
+\r
+<tscreen><verb>\r
+set/baddx\r
+set/badspotter\r
+set/badnode\r
+</verb></tscreen>\r
+\r
+These work in the same as the <em>set/badword</em> command, you can add\r
+any words or callsigns or whatever to the appropriate database. For\r
+example, to stop a spot from a particular node you do:\r
+\r
+<tscreen><verb>\r
+set/badnode gb7djk gb7dxc\r
+</verb></tscreen>\r
+\r
+a bad spotter:\r
+\r
+<tscreen><verb>\r
+set/badspotter b0mb p1rat nocall\r
+</verb></tscreen>\r
+\r
+and some bad dx:\r
+\r
+<tscreen><verb>\r
+set/baddx video wsjt\r
+</verb></tscreen>\r
+\r
+You can remove a word using the appropriate unset command\r
+(<em>unset/baddx, unset/badspotter, unset/badnode</em>) or list them\r
+using one of <em>show/baddx, show/badspotter</em> and\r
+<em>show/badnode</em>.\r
+\r
+<sect>Mail\r
+\r
+<P>\r
+DXSpider deals seamlessly with standard AK1A type mail. It supports both\r
+personal and bulletin mail and the sysop has additional commands to ensure\r
+that mail gets to where it is meant. DXSpider will send mail almost\r
+immediately, assuming that the target is on line. However, only one\r
+mail message is dealt with at any one time. If a mail message is already\r
+being sent or recieved, then the new message will be queued until it has\r
+finished.\r
+\r
+The cluster mail is automatically deleted after 30 days unless the sysop\r
+sets the "keep" flag using the <em>msg</em> command.\r
+\r
+<sect1>Personal mail\r
+\r
+<P>\r
+Personal mail is sent using the <em>sp</em> command. This is actually the\r
+default method of sending mail and so a simple <em>s</em> for send will do.\r
+A full list of the send commands and options is in the <em>command set</em>\r
+section, so I will not duplicate them here.\r
+\r
+<sect1>Bulletin mail\r
+\r
+<P>\r
+Bulletin mail is sent by using the <em>sb</em> command. This is one of the\r
+most common mistakes users make when sending mail. They send a bulletin\r
+mail with <em>s</em> or <em>sp</em> instead of <em>sb</em> and of course\r
+the message never leaves the cluster. This can be rectified by the sysop\r
+by using the <em>msg</em> command.\r
+\r
+<P>Bulletin addresses can be set using the Forward.pl file.\r
+\r
+<sect1>Forward.pl\r
+\r
+<P>\r
+DXSpider receives all and any mail sent to it without any alterations needed\r
+in files. Because personal and bulletin mail are treated differently, there\r
+is no need for a list of accepted bulletin addresses. It is necessary, however,\r
+to tell the program which links accept which bulletins. For example, it is\r
+pointless sending bulletins addresses to "UK" to any links other than UK\r
+ones. The file that does this is called forward.pl and lives in /spider/msg.\r
+At default, like other spider files it is named forward.pl.issue. Rename it\r
+to forward.pl and edit the file to match your requirements.\r
+The format is below ...\r
+\r
+<tscreen><verb>\r
+#\r
+# this is an example message forwarding file for the system\r
+#\r
+# The format of each line is as follows\r
+#\r
+# type to/from/at pattern action destinations\r
+# P/B/F T/F/A regex I/F [ call [, call ...] ]\r
+#\r
+# type: P - private, B - bulletin (msg), F - file (ak1a bull)\r
+# to/from/at: T - to field, F - from field, A - home bbs, O - origin \r
+# pattern: a perl regex on the field requested\r
+# action: I - ignore, F - forward\r
+# destinations: a reference to an array containing node callsigns\r
+#\r
+# if it is non-private and isn't in here then it won't get forwarded \r
+#\r
+# Currently only type B msgs are affected by this code.\r
+# \r
+# The list is read from the top down, the first pattern that matches\r
+# causes the action to be taken.\r
+#\r
+# The pattern can be undef or 0 in which case it will always be selected\r
+# for the action specified\r
+#\r
+# If the BBS list is undef or 0 and the action is 'F' (and it matches the\r
+# pattern) then it will always be forwarded to every node that doesn't have \r
+# it (I strongly recommend you don't use this unless you REALLY mean it, if\r
+# you allow a new link with this on EVERY bull will be forwarded immediately\r
+# on first connection)\r
+#\r
+\r
+package DXMsg;\r
+\r
+@forward = (\r
+'B', 'T', 'LOCAL', 'F', [ qw(GB7MBC) ],\r
+'B', 'T', 'ALL', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],\r
+'B', 'T', 'UK', 'F', [ qw(GB7BAA GB7ADX) ],\r
+'B', 'T', 'QSL', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],\r
+'B', 'T', 'QSLINF', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],\r
+'B', 'T', 'DX', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],\r
+'B', 'T', 'DXINFO', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],\r
+'B', 'T', 'DXNEWS', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],\r
+'B', 'T', 'DXQSL', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],\r
+'B', 'T', 'SYSOP', 'F', [ qw(GB7BAA GB7ADX) ],\r
+'B', 'T', '50MHZ', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],\r
+);\r
+</verb></tscreen>\r
+\r
+Simply insert a bulletin address and state in the brackets where you wish\r
+that mail to go. For example, you can see here that mail sent to "UK" will\r
+only be sent to the UK links and not to PA4AB-14.\r
+\r
+<P>\r
+To force the cluster to reread the file use load/forward\r
+\r
+<P>\r
+NB: If a user tries to send mail to a bulletin address that does not exist\r
+in this file, they will get an error.\r
+\r
+<sect1>The msg command\r
+\r
+<P>\r
+The <em>msg</em> command is a very powerful and flexible tool for the\r
+sysop. It allows the sysop to alter to and from fields and make other\r
+changes to manage the cluster mail.\r
+\r
+Here is a full list of the various options ...\r
+\r
+<tscreen><verb>\r
+ MSG TO <msgno> <call> - change TO callsign to <call>\r
+ MSG FRom <msgno> <call> - change FROM callsign to <call>\r
+ MSG PRrivate <msgno> - set private flag\r
+ MSG NOPRrivate <msgno> - unset private flag\r
+ MSG RR <msgno> - set RR flag\r
+ MSG NORR <msgno> - unset RR flag\r
+ MSG KEep <msgno> - set the keep flag (message won't be deleted ever)\r
+ MSG NOKEep <msgno> - unset the keep flag\r
+ MSG SUbject <msgno> <new> - change the subject to <new>\r
+ MSG WAittime <msgno> - remove any waiting time for this message\r
+ MSG NOREad <msgno> - mark message as unread\r
+ MSG REad <msgno> - mark message as read\r
+ MSG QUeue - queue any outstanding bulletins\r
+ MSG QUeue 1 - queue any outstanding private messages\r
+</verb></tscreen>\r
+\r
+These commands are simply typed from within the cluster as the sysop user.\r
+\r
+<sect1>Message status\r
+\r
+<P>\r
+You can check on a message from within the cluster by using the command\r
+<em>stat/msg</em>. This will give you additional information on the\r
+message number including which nodes have received it, which node it\r
+was received from and when etc. Here is an example of the output of\r
+the command ...\r
+\r
+<tscreen><verb>\r
+G0VGS de GB7MBC 28-Jan-2001 1308Z >\r
+stat/msg 6869\r
+ From: GB7DJK\r
+ Msg Time: 26-Jan-2001 1302Z\r
+ Msgno: 6869\r
+ Origin: GB7DJK\r
+ Size: 8012\r
+ Subject: AMSAT 2line KEPS 01025.AMSAT\r
+ To: UK\r
+Got it Nodes: GB7BAA, GB7ADX\r
+ Private: 0\r
+Read Confirm: 0\r
+ Times read: 0\r
+G0VGS de GB7MBC 28-Jan-2001 1308Z >\r
+</verb></tscreen>\r
+\r
+<sect1>Filtering mail\r
+\r
+<P>\r
+This is described in the section on <em>Other filters</em> so I will not\r
+duplicate it here.\r
+\r
+<sect1>Distribution lists\r
+\r
+<P>\r
+Distribution lists are simply a list of users to send certain types of\r
+mail to. An example of this is mail you only wish to send to other\r
+sysops. In /spider/msg there is a directory called <em>distro</em>. You\r
+put any distibution lists in here. For example, here is a file called\r
+SYSOP.pl that caters for the UK sysops.\r
+\r
+<tscreen><verb>\r
+qw(GB7TLH GB7DJK GB7DXM GB7CDX GB7BPQ GB7DXN GB7MBC GB7MBC-6 GB7MDX\r
+ GB7NDX GB7SDX GB7TDX GB7UDX GB7YDX GB7ADX GB7BAA GB7DXA GB7DXH \r
+ GB7DXK GB7DXI GB7DXS)\r
+</verb></tscreen>\r
+\r
+Any mail sent to "sysop" would only be sent to the callsigns in this list.\r
+\r
+<sect1>BBS interface\r
+\r
+<P>\r
+Spider provides a simple BBS interface. No input is required from the sysop\r
+of the cluster at all. The BBS simply sets the cluster as a BBS and pushes\r
+any required mail to the cluster. No mail can flow from Spider to the BBS,\r
+the interface is one-way.\r
+\r
+<P>\r
+Please be careful not to flood the cluster network with unnecessary mail.\r
+Make sure you only send mail to the clusters that want it by using the\r
+Forward.pl file very carefully.\r
+\r
+<sect>Scripts\r
+\r
+<p>\r
+From 1.48 onwards it will become increasingly possible to control DXSpider's\r
+operation with scripts of various kinds.\r
+\r
+<P>\r
+The directory /spider/scripts is where it all happens and is used for several \r
+things. Firstly it contains a file called startup that can be used to call \r
+in any changes to the cluster from the default settings on startup. This\r
+script is executed immediately after all initialisation of the node is done\r
+but before any connections are possible. Examples of this include how many \r
+spots it is possible to get with the sh/dx command, whether you want \r
+registration/passwords to be permanently on etc. An example file is shown \r
+below and is included in the distribution as startup.issue.\r
+\r
+<tscreen><verb>\r
+#\r
+# startup script example\r
+#\r
+# set maximum no of spots allowed to 100\r
+# set/var $Spot::maxspots = 100\r
+#\r
+# Set registration on\r
+# set/var $main::reqreg = 1\r
+#\r
+# Set passwords on\r
+# set/var $main::passwdreq = 1\r
+#\r
+</verb></tscreen>\r
+\r
+<P>\r
+As usual, any text behind a # is treated as a comment and not read. To use\r
+this file, simply rename it from startup.issue to startup. In our example\r
+above there are three options. The first option is the amount of spots that\r
+a user can request with the <em>sh/dx</em> command. Normally the default is\r
+to give 10 spots unless the user specifies more. Without this line enabled,\r
+the maximum a user can request is 100 spots. Depending on your link quality\r
+you may wish to enable more or less by specifying the number.\r
+\r
+<P>\r
+The other 2 options are dealt with more fully in the security section.\r
+\r
+<P>\r
+Secondly, it is used to store the login scripts for users and nodes. Currently\r
+this can only be done by the sysop but it is envisaged that eventually users will \r
+be able to set their own. An example is included in the distibution but here is \r
+a further example.\r
+\r
+<tscreen><verb>\r
+#\r
+# G0FYD\r
+#\r
+blank +\r
+sh/wwv 3\r
+blank +\r
+sh/dx \r
+blank +\r
+t g0jhc You abt?\r
+blank +\r
+</verb></tscreen>\r
+\r
+The lines in between commands can simply insert a blank line or a character\r
+such as a + sign to make the output easier to read. Simply create this script\r
+with your favourite editor and save it with the callsign of the user as the\r
+filename. Filenames should always be in lower case.\r
+\r
+<P>\r
+Commands can be inserted in the same way for nodes. A node may wish a series\r
+of commands to be issued on login, such as a merge command for example.\r
+\r
+<P>\r
+Thirdly, there are 2 default scripts for users and nodes who do not have a\r
+specifically defined script. These are <em>user_default</em> and\r
+<em>node_default</em>\r
+\r
+<sect>Databases\r
+\r
+<P>\r
+Spider allows the creation of local or remote databases. It supports\r
+chained databases, allowing several different databases to be scanned\r
+with one simple command. Importing of databases is limited at present\r
+to the standard AK1A databases such as OBLAST and the DB0SDX QSL \r
+database but will expand with time.\r
+\r
+<sect1>Creating databases\r
+\r
+<P>\r
+Creating a database could not be more simple. All the commands are\r
+sent from the cluster prompt as the <em>sysop</em> user.\r
+\r
+To create a database you use the command <em>dbcreate</em>. It can\r
+be used in 3 different ways like so ..\r
+\r
+<tscreen><verb>\r
+dbcreate <name>\r
+</verb></tscreen>\r
+\r
+To simply create a database locally, you just tell the command the\r
+name of the database. This does not create the actual database, it\r
+simply defines it to say that it exists.\r
+\r
+<tscreen><verb>\r
+dbcreate <name> chain <name> [<name>...]\r
+</verb></tscreen>\r
+\r
+This creates a chained database entry. The first database will be\r
+scanned, then the second, the third etc...\r
+\r
+<tscreen><verb>\r
+dbcreate <name> remote <name>\r
+</verb></tscreen>\r
+\r
+This creates a remote entry. the first name field is the database\r
+name at the remote node, then the remote switch, then the actual\r
+node_call of the remote node, for example...\r
+\r
+<tscreen><verb>\r
+dbcreate buckmaster remote gb7dxc\r
+</verb></tscreen>\r
+\r
+Remote databases cannot be chained, however, the last database in a\r
+chain can be a remote database.\r
+\r
+<sect1>Importing databases\r
+\r
+<P>\r
+The only databases that Spider can currently import are the standard\r
+AK1A databases such as OBLAST or the DB0SDX qsl and address database.\r
+This will be added to with time.\r
+\r
+To import such a database, first put the file somewhere useful like /tmp\r
+and then issue the following command ...\r
+\r
+<tscreen><verb>\r
+dbimport oblast /tmp/OBLAST.FUL\r
+</verb></tscreen>\r
+\r
+This will update the existing local oblast database or create it if\r
+it does not exist.\r
+\r
+<sect1>Checking available databases\r
+\r
+<P>\r
+Once a database is created, you will want to check that it has been\r
+added. To do this use the <em>dbavail</em> command. This will\r
+output the available databases. For example ...\r
+\r
+<tscreen><verb>\r
+dbavail\r
+DB Name Location Chain\r
+qsl Local\r
+buck GB7ADX\r
+hftest GB7DXM\r
+G0VGS de GB7MBC 3-Feb-2001 1925Z >\r
+</verb></tscreen>\r
+\r
+<sect1>Looking up databases\r
+\r
+<P>\r
+To look for information in a defined database, simply use the <em>dbshow</em>\r
+command, for example ...\r
+\r
+<tscreen><verb>\r
+dbshow buckmaster G0YLM\r
+</verb></tscreen>\r
+\r
+will show the information for the callsign G0YLM from the buckmaster\r
+database if it exists. To make things more standard for the users\r
+you can add an entry in the Aliases file so that it looks like a standard \r
+<em>show</em> command like this ...\r
+\r
+<tscreen><verb>\r
+'^sh\w*/buc', 'dbshow buckmaster', 'dbshow',\r
+</verb></tscreen>\r
+\r
+Now you can simply use show/buckmaster or an abreviation.\r
+\r
+<sect1>Removing databases\r
+\r
+<P>\r
+To delete an existing database you use the <em>dbremove</em> command.\r
+For example ...\r
+\r
+<tscreen><verb>\r
+dbremove oblast\r
+</verb></tscreen>\r
+\r
+would remove the oblast database and its associated datafile from the\r
+system. There are no warnings or recovery possible from this command.\r
+If you remove a database it ceases to exist and would have to be created\r
+from scratch if you still required it.\r
+\r
+<sect>Information, files and useful programs\r
+\r
+<sect1>MOTD\r
+\r
+<P>\r
+One of the more important things a cluster sysop needs to do is to get \r
+information to his users. The simplest way to do this is to have a banner \r
+that is sent to the user on login. This is know as a "message of the day" \r
+or "motd". To set this up, simply create a file in /spider/data called motd \r
+and edit it to say whatever you want. It is purely a text file and will be \r
+sent automatically to anyone logging in to the cluster.\r
+\r
+<sect1>MOTD_NOR\r
+\r
+<P>\r
+This message of the day file lives in the same directory as the standard\r
+motd file but is only sent to non-registered users. Once registered they\r
+will receive the same message as any other user.\r
+\r
+<sect1>Downtime message\r
+\r
+<P>\r
+If for any reason the cluster is down, maybe for upgrade or maintenance but \r
+the machine is still running, a message can be sent to the user advising them \r
+of the fact. This message lives in the /spider/data directory and is called\r
+"offline". Simply create the file and edit it to say whatever you wish. \r
+This file will be sent to a user attempting to log into the cluster when\r
+DXSpider is not actually running.\r
+\r
+<sect1>Other text messages\r
+\r
+<P>\r
+You can set other text messages to be read by the user if they input the file \r
+name. This could be for news items or maybe information for new users. \r
+To set this up, make a directory under /spider called <em>packclus</em>. \r
+Under this directory you can create files called <em>news</em> or <em>newuser</em>\r
+for example. In fact you can create files with any names you like. These can \r
+be listed by the user with the command ....\r
+\r
+<tscreen><verb>\r
+show/files\r
+</verb></tscreen>\r
+\r
+They can be read by the user by typing the command ....\r
+\r
+<tscreen><verb>\r
+type news\r
+</verb></tscreen>\r
+\r
+If the file they want to read is called <em>news</em>. You could also set \r
+an alias for this in the Alias file to allow them just to type <em>news</em>\r
+\r
+<P>\r
+You can also store other information in this directory, either directly or \r
+nested under directories. One use for this would be to store DX bulletins \r
+such as the OPDX bulletins. These can be listed and read by the user. \r
+To keep things tidy, make a directory under /spider/packclus called\r
+<em>bulletin</em>. Now copy any OPDX or similar bulletins into it. These \r
+can be listed by the user in the same way as above using the <em>show/files</em>\r
+command with an extension for the bulletin directory you have just created, \r
+like this ....\r
+\r
+<tscreen><verb>\r
+show/files bulletin\r
+</verb></tscreen>\r
+\r
+<P>\r
+An example would look like this ....\r
+\r
+<tscreen><verb>\r
+sh/files\r
+bulletin DIR 20-Dec-1999 1715Z news 1602 14-Dec-1999 1330Z\r
+</verb></tscreen>\r
+\r
+You can see that in the files area (basically the packclus directory) there is a \r
+file called <em>news</em> and a directory called <em>bulletin</em>. You can \r
+also see that dates they were created. In the case of the file <em>news</em>, \r
+you can also see the time it was last modified, a good clue as to whether the \r
+file has been updated since you last read it. To read the file called \r
+<em>news</em> you would simply issue the command ....\r
+\r
+<tscreen><verb>\r
+type news\r
+</verb></tscreen>\r
+\r
+To look what is in the bulletin directory you issue the command ....\r
+\r
+<tscreen><verb>\r
+show/files bulletin\r
+opdx390 21381 29-Nov-1999 1621Z opdx390.1 1670 29-Nov-1999 1621Z\r
+opdx390.2 2193 29-Nov-1999 1621Z opdx391 25045 29-Nov-1999 1621Z \r
+opdx392 35969 29-Nov-1999 1621Z opdx393 15023 29-Nov-1999 1621Z \r
+opdx394 33429 29-Nov-1999 1621Z opdx394.1 3116 29-Nov-1999 1621Z \r
+opdx395 24319 29-Nov-1999 1621Z opdx396 32647 29-Nov-1999 1621Z\r
+opdx396.1 5537 29-Nov-1999 1621Z opdx396.2 6242 29-Nov-1999 1621Z\r
+opdx397 18433 29-Nov-1999 1621Z opdx398 19961 29-Nov-1999 1621Z \r
+opdx399 17719 29-Nov-1999 1621Z opdx400 19600 29-Nov-1999 1621Z\r
+opdx401 27738 29-Nov-1999 1621Z opdx402 18698 29-Nov-1999 1621Z\r
+opdx403 24994 29-Nov-1999 1621Z opdx404 15685 29-Nov-1999 1621Z\r
+opdx405 13984 29-Nov-1999 1621Z opdx405.1 4166 29-Nov-1999 1621Z\r
+opdx406 28934 29-Nov-1999 1621Z opdx407 24153 29-Nov-1999 1621Z\r
+opdx408 15081 29-Nov-1999 1621Z opdx409 23234 29-Nov-1999 1621Z\r
+Press Enter to continue, A to abort (16 lines) >\r
+</verb></tscreen>\r
+\r
+You can now read any file in this directory using the type command, like this ....\r
+\r
+<tscreen><verb>\r
+type bulletin/opdx391\r
+Ohio/Penn DX Bulletin No. 391\r
+The Ohio/Penn Dx PacketCluster\r
+DX Bulletin No. 391\r
+BID: $OPDX.391\r
+January 11, 1999\r
+Editor Tedd Mirgliotta, KB8NW\r
+Provided by BARF-80 BBS Cleveland, Ohio\r
+Online at 440-237-8208 28.8k-1200 Baud 8/N/1 (New Area Code!)\r
+Thanks to the Northern Ohio Amateur Radio Society, Northern Ohio DX\r
+Association, Ohio/Penn PacketCluster Network, K1XN & Golist, WB2RAJ/WB2YQH\r
+& The 59(9) DXReport, W3UR & The Daily DX, K3TEJ, KN4UG, W4DC, NC6J, N6HR,\r
+Press Enter to continue, A to abort (508 lines) >\r
+</verb></tscreen>\r
+\r
+The page length will of course depend on what you have it set to!\r
+\r
+<sect1>The Aliases file\r
+\r
+<P>\r
+You will find a file in /spider/cmd/ called Aliases. This is the file that\r
+controls what a user gets when issuing a command. It is also possible to\r
+create your own aliases for databases and files you create locally.\r
+\r
+<P>\r
+You should not alter the original file in /spider/cmd/ but create a new file\r
+with the same name in /spider/local_cmd. This means that any new Aliases files\r
+that is downloaded will not overwrite your self created Aliases and also that\r
+you do not override any new Aliases with your copy in /spider/local_cmd/. You\r
+must remember that any files you store in /spider/local/ or /spider/local_cmd\r
+override the originals if the same lines are used in both files.\r
+\r
+<P>\r
+The best way of dealing with all this then is to only put your own locally\r
+created Aliases in the copy in /spider/local_cmd. The example below is\r
+currently in use at GB7MBC.\r
+\r
+<tscreen><verb>\r
+\r
+#\r
+# Local Aliases File\r
+#\r
+\r
+package CmdAlias;\r
+\r
+%alias = (\r
+ 'n' => [\r
+ '^news$', 'type news', 'type',\r
+ ],\r
+ 's' => [\r
+ '^sh\w*/buck$', 'show/qrz', 'show',\r
+ '^sh\w*/hftest$', 'dbshow hftest', 'dbshow',\r
+ '^sh\w*/qsl$', 'dbshow qsl', 'dbshow',\r
+ '^sh\w*/vhf$', 'dbshow vhf', 'dbshow',\r
+ '^sh\w*/vhftest$', 'dbshow vhftest', 'dbshow',\r
+ ],\r
+)\r
+\r
+</verb></tscreen>\r
+\r
+<P>\r
+Each alphabetical section should be preceded by the initial letter and the section\r
+should be wrapped in square brackets as you can see. The syntax is straightforward.\r
+The first section on each line is the new command that will be allowed once the\r
+alias is included. The second section is the command it is replacing and the last\r
+section is the actual command that is being used.\r
+\r
+<P>\r
+The eagle-eyed amongst you will have noticed that in the first section, the new\r
+alias command has a '^' at the start and a '$' at the end. Basically these force\r
+a perfect match on the alias. The '^' says match the beginning exactly and the\r
+'$' says match the end exactly. This prevents unwanted and unintentional matches\r
+with similar commands.\r
+\r
+<P>\r
+I have 3 different types of alias in this file. At the top is an alias for 'news'. \r
+This is a file I have created in the /spider/packclus/ directory where I can inform \r
+users of new developments or points of interest. In it's initial form a user would \r
+have to use the command <em>type news</em>. The alias allows them to simply type \r
+<em>news</em> to get the info. Second is an alias for the <em>show/qrz</em>\r
+command so that those users used to the original <em>show/buck</em> command in\r
+AK1A will not get an error, and the rest of the lines are for locally created\r
+databases so that a user can type <em>show/hftest</em> instead of having to use\r
+the command <em>dbshow hftest</em> which is not as intuitive.\r
+\r
+<P>\r
+This file is just an example and you should edit it to your own requirements.\r
+Once created, simply issue the command <em>load/alias</em> at the cluster\r
+prompt as the sysop user and the aliases should be available.\r
+\r
+\r
+<sect1>Console.pl\r
+\r
+<P>\r
+In later versions of Spider a simple console program is provided for the sysop. \r
+This has a type ahead buffer with line editing facilities and colour for spots,\r
+announces etc. To use this program, simply use console.pl instead of client.\r
+\r
+<P>\r
+To edit the colours, copy /spider/perl/Console.pl to /spider/local and edit the \r
+file with your favourite editor.\r
+\r
+<sect1>Updating kepler data\r
+\r
+<P>\r
+Spider has a powerful and flexible show/satellite command. In order for\r
+this to be accurate, the kepler data has to be updated regularly. In\r
+general, this data is available as an email or via cluster mail.\r
+Updating it is simple. First you need to export the mail message as a\r
+file. You do this with the <em>export</em> command from the cluster prompt\r
+as the sysop. For example ...\r
+\r
+<tscreen><verb>\r
+export 5467 /spider/perl/keps.in\r
+</verb></tscreen>\r
+\r
+<P>\r
+would export message number 5467 as a file called keps.in in the\r
+/spider/perl directory.\r
+\r
+<P>\r
+Now login to a VT as sysop and cd /spider/perl. There is a command in\r
+the perl directory called <em>convkeps.pl</em>. All we need to do now is\r
+convert the file like so ...\r
+\r
+<tscreen><verb>\r
+./convkeps.pl keps.in\r
+</verb></tscreen>\r
+\r
+<P>\r
+Now go back to the cluster and issue the command ...\r
+\r
+<tscreen><verb>\r
+load/keps\r
+</verb></tscreen>\r
+\r
+<P>\r
+That is it! the kepler data has been updated.\r
+\r
+<sect1>The QRZ callbook\r
+\r
+<P>\r
+The command <em>sh/qrz</em> will only work once you have followed a few\r
+simple steps. First you need to get a user ID and password from qrz.com.\r
+Simply go to the site and create one. Secondly you need to copy the file\r
+/spider/perl/Internet.pm to /spider/local and alter it to match your user\r
+ID and password. You also at this point need to set $allow=1 to complete\r
+the setup. Many thanks to Fred Lloyd, the proprieter of\r
+<htmlurl url="http://www.qrz.com" name="qrz.com"> for allowing this access.\r
+\r
+<sect1>Connecting logging programs\r
+\r
+<P>\r
+There appear to be very few logging programs out there that support telnet\r
+especially the popular ones like LogEQF, Turbolog etc. This can make it\r
+difficult to connect to your own cluster!\r
+The way to do it is to make the logging program think it has a TNC attached\r
+to a com port on the logging PC and 'push' a linux login out to it.\r
+This is achieved very simply by the use of <em>agetty</em>.\r
+\r
+<P>\r
+All that is required is to add a line in /etc/inittab to have the client\r
+ready for a connection on the com port of your choice. Remember that in\r
+Linux, the com ports start at ttyS0 for com1, ttyS1 for com2 etc.\r
+\r
+<tscreen><verb>\r
+c4:2345:respawn:/sbin/agetty -L 9600 ttyS1\r
+</verb></tscreen>\r
+\r
+<P>\r
+Add this after the standard runlevel lines in /etc/inittab. The above\r
+line works on ttyS1 (com2). Now as root, issue the command <em>telinit q</em>\r
+and it should be ready for connection. All that is required is a 3 wire\r
+serial lead (tx, rx and signal ground). Tell you logging program to use\r
+8n1 at 9600 baud and you should see a Linux login prompt. Login as normal\r
+and then telnet from there to the cluster.\r
+\r
+<sect>Java Web applet\r
+\r
+<P>\r
+In the spider tree will be a directory <em>spider-web</em>. This is a\r
+neat little java web applet that can be run from a website. The applet\r
+must run on the same machine as the cluster. The included README file is\r
+shown below.\r
+\r
+<P>\r
+I should comment here that the applet is precompiled, that is, ready to go.\r
+It was compiled using JDK1.3.1. If your version is earlier than this then it\r
+may not work. Should that be the case you need to recompile or update your\r
+JDK. To recompile do the following ...\r
+\r
+<tscreen><verb>\r
+cd /spider/spider-web\r
+rm *.class\r
+/usr/bin/javac spiderclient.java\r
+</verb></tscreen>\r
+\r
+<P>\r
+I have used /usr/bin/javac as an example, your path to javac may be different.\r
+\r
+<verb>\r
+Spider-WEB v0.6b\r
+\r
+Completely based on a clx web client written in Java by dl6dbh\r
+(ftp://clx.muc.de/pub/clx/clx-java_10130001.tgz)\r
+\r
+The webserver has to run on the same machine as your DxSpider software!\r
+\r
+It is assumed that you have Java installed. You need JDK1.3.1 at least.\r
+\r
+Installation instructions (Performed as root):\r
+\r
+Put all the files in the spider-web directory into a newly created directory\r
+under the DocumentRoot of your websever for instance 'client'. In my case\r
+this is: /home/httpd/html/client/ although ymmv. For Suse the correct\r
+path should be /usr/local/httpd/htdocs/client/ for example.\r
+\r
+Move spider.cgi to the cgi-bin directory of your webserver, in my case that is\r
+/home/httpd/cgi-bin/ although ymmv. For Suse the correct path should be\r
+/usr/local/httpd/cgi-bin/ for example.\r
+\r
+Change the permissions of the files to ensure they are correct, obviously you\r
+will need to use the correct path the the files according to your system:\r
+\r
+chmod 755 /home/httpd/html/cgi-bin/spider.cgi\r
+chmod -R 755 /home/httpd/html/client/\r
+\r
+By default the spider.cgi script should pick up your hostname (As long as this\r
+is set correctly). If it does not or your hostname differs from the name that\r
+you attach to the public address that you are using, then edit spider.cgi :\r
+\r
+# Uncomment and set the hostname manually here if the above fails.\r
+# $HOSTNAME = "gb7mbc.spoo.org" ;\r
+$PORT = "8000" ;\r
+\r
+'HOSTNAME' is the hostname of your cluster.\r
+\r
+'PORT' is the portnumber that you use to connect to your DxSpider via\r
+telnet (see Listeners.pm)\r
+\r
+NOTE: If you can start the console but cannot connect to the cluster from it,\r
+then it is possible that the machine you are on cannot resolve the hostname of \r
+your cluster machine. If this is the case, you need to set your hostname \r
+manually as above.\r
+\r
+You also need to set the $NODECALL variable. This prints the name of your\r
+choosing (probably your cluster callsign) on the html page.\r
+\r
+You now can connect to Spider-Web via http://yourserver/cgi-bin/spider.cgi\r
+</verb>\r
+\r
+<sect>Web based statistics\r
+\r
+<P>\r
+From version 1.50, you can use the freeware software MRTG to produce\r
+really nice graphical statistics on your web site. For an example\r
+try <htmlurl url="http://www.gb7mbc.net/mrtg/stats.html" name="http://www.gb7mbc.net/mrtg/stats.html">.\r
+\r
+<P>\r
+The following should help you get it all working.\r
+\r
+<P>\r
+First you need to download the latest version of MRTG from <htmlurl url="http://people.ee.ethz.ch/~oetiker/webtools/mrtg/" name="http://people.ee.ethz.ch/~oetiker/webtools/mrtg/">.\r
+You will also need the following files..\r
+\r
+<tscreen><verb>\r
+libpng-1.0.14.tar.gz\r
+zlib-1.1.4.tar.gz\r
+gd-1.8.3.tar.gz\r
+</verb></tscreen>\r
+\r
+Login to your machine as the root user, put all the downloaded files \r
+in /usr/local/src/ (or wherever you prefer) and untar and compile them. \r
+All the information to compile and install these sources come with them.\r
+After compilation and installation, you will find MRTG in /usr/local/mrtg-2.\r
+\r
+<P>\r
+Now copy all the files in /usr/local/src/mrtg-2.9.22/images/ to \r
+/spider/html/mrtg/\r
+\r
+<P>\r
+You now need to make 2 symbolic links like below...\r
+\r
+<tscreen><verb>\r
+ln -s /usr/local/mrtg-2/bin/mrtg /usr/bin/mrtg\r
+ln -s /usr/local/mrtg-2/lib/mrtg2 /usr/lib/mrtg2\r
+</verb></tscreen>\r
+\r
+<P>\r
+Now login to the cluster with your sysop callsign and run the command \r
+"mrtg all".\r
+\r
+<P>Now you are nearly there! Login as the sysop user and change to the\r
+/spider/html/mrtg/ directory. Now run the command <em>indexmaker</em> as\r
+shown below...\r
+\r
+<tscreen><verb>\r
+indexmaker --output stats.html --columns=1 --title "MRTG statistics for GB7DJK" ../../mrtg/mrtg.cfg\r
+</verb></tscreen>\r
+\r
+Changing the callsign for your own cluster callsign of course!\r
+\r
+<P>\r
+And finally you need to login as the root user and create one last\r
+symbolic link. Where this points will depend on where your html\r
+documents are kept. For RedHat systems you use...\r
+\r
+<tscreen><verb>\r
+ln -s /home/sysop/spider/html/mrtg /home/httpd/html/mrtg\r
+</verb></tscreen>\r
+\r
+and for SuSE systems...\r
+\r
+<tscreen><verb>\r
+ln -s /home/sysop/spider/html/mrtg /usr/local/httpd/htdocs/mrtg\r
+</verb></tscreen>\r
+\r
+If you now point your browser to your website as below it should all\r
+be happening!\r
+\r
+<tscreen><verb>\r
+http://www.xxx.xxx/mrtg/stats.html\r
+</verb></tscreen>\r
+\r
+Of course, to get the stats to update, you need to add some information\r
+in the spider crontab file as below...\r
+\r
+<tscreen><verb>\r
+# Update stats for mrtg on website\r
+00,05,10,15,20,25,30,35,40,45,50,55 * * * * run_cmd('mrtg all')\r
+</verb></tscreen>\r
+\r
+This will update the site every 5 minutes.\r
+\r
+<sect>Security\r
+\r
+<P>\r
+From version 1.49 DXSpider has some additional security features. These\r
+are not by any means meant to be exhaustive, however they do afford some\r
+security against piracy. These two new features can be used independently \r
+of each other or in concert to tighten the security.\r
+\r
+<sect1>Registration\r
+\r
+<P>\r
+The basic principle of registration is simple. If a user is not registered\r
+by the sysop, then they have read-only access to the cluster. The only\r
+thing they can actually send is a talk or a message to the sysop. In\r
+order for them to be able to spot, send announces or talks etc the sysop\r
+must register them with the <em>set/register</em> command, like this ...\r
+\r
+<tscreen><verb>\r
+set/register g0vgs\r
+</verb></tscreen>\r
+\r
+The user g0vgs can now fully use the cluster. In order to enable \r
+registration, you can issue the command ...\r
+\r
+<tscreen><verb>\r
+set/var $main::reqreg = 1\r
+</verb></tscreen>\r
+\r
+Any users that are not registered will now see the motd_nor file rather\r
+than the motd file as discussed in the Information, files and useful \r
+programs section.\r
+\r
+<P>\r
+Entering this line at the prompt will only last for the time the cluster\r
+is running of course and would not be present on a restart. To make the\r
+change permanent, add the above line to /spider/scripts/startup. To\r
+read more on the startup file, see the section on Information, files \r
+and useful programs.\r
+\r
+<P>\r
+To unregister a user use <em>unset/register</em> and to show the list\r
+of registered users, use the command <em>show/register</em>.\r
+\r
+<sect1>Passwords\r
+\r
+<P>\r
+At the moment, passwords only affect users who login to a DXSpider\r
+cluster node via telnet. If a user requires a password, they can\r
+either set it themselves or have the sysop enter it for them by using\r
+the <em>set/password</em> command. Any users who already have passwords, \r
+such as remote sysops, will be asked for their passwords automatically \r
+by the cluster. Using passwords in this way means that the user has a\r
+choice on whether to have a password or not. To force the use of\r
+passwords at login, issue the command ...\r
+\r
+<tscreen><verb>\r
+set/var $main::passwdreq = 1\r
+</verb></tscreen>\r
+\r
+at the cluster prompt. This can also be added to the /spider/scripts/startup\r
+file as above to make the change permanent.\r
+\r
+<P>\r
+Of course, if you do this you will have to assign a password for each of \r
+your users. If you were asking them to register, it is anticipated that\r
+you would ask them to send you a message both to ask to be registered and\r
+to give you the password they wish to use.\r
+\r
+<P>\r
+Should a user forget their password, it can be reset by the sysop by\r
+first removing the existing password and then setting a new one like so ...\r
+\r
+<tscreen><verb>\r
+unset/password g0vgs\r
+set/password g0vgs new_password\r
+</verb></tscreen>\r
+\r
+<sect>CVS\r
+\r
+<sect1>CVS from a Linux platform\r
+\r
+<P>\r
+CVS stands for "Concurrent Versions System" and the CVS for DXSpider is held\r
+at <htmlurl url="http://www.sourceforge.net" name="Sourceforge">. This means\r
+that it is possible to update your DXSpider installation to the latest\r
+sources by using a few simple commands. A graphical interface to CVS for\r
+Windows is explained in the next section.\r
+\r
+<P>\r
+Please be aware that if you update your system using CVS, it is possible that\r
+you could be running code that is very beta and not fully tested. There is\r
+a possibility that it could be unstable.\r
+\r
+<P>\r
+I am of course assuming that you have a machine with both DXSpider and\r
+Internet access running.\r
+\r
+<P>\r
+BEFORE YOU EVEN CONSIDER STARTING WITH THIS MAKE A BACKUP OF YOUR\r
+ENTIRE SPIDER TREE!!\r
+\r
+<P>\r
+Assuming you are connected to the Internet, you need to login to the\r
+CVS repository and then update your Spider source. There are several\r
+steps which are listed below ...\r
+\r
+<P>\r
+First login as the user <em>sysop</em>. Next you need to connect to the CVS\r
+repository. You do this with the command below ...\r
+\r
+<verb>\r
+cvs -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login\r
+</verb>\r
+\r
+You will get a password prompt. Simply hit return here and your machine should\r
+return to a normal linux prompt.\r
+\r
+<P>\r
+What happens next depends on whether you have an existing installation that\r
+you want to update with the latest and greatest or whether you just want\r
+to see what is there and/or run it on a new machine for testing.\r
+\r
+If you are installing Spider from CVS then change directory to /home/sysop\r
+\r
+If you are wanting to update Spider then cd to /tmp\r
+\r
+<P>\r
+The next step will create a brand new 'spider' directory in your current\r
+directory.\r
+\r
+<verb>\r
+cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/dxspider co spider\r
+</verb>\r
+\r
+This command is all on one line.\r
+\r
+<P>\r
+Hopefully your screen should show you downloading files. The -z3 simply compresses\r
+the download to improve speed.\r
+When this has finished, you will have exactly the same as if you had untarred a full\r
+tarball PLUS some extra directories and files that CVS needs to do the magic that\r
+it does.\r
+\r
+<P>\r
+Now if you are doing a new installation, that's it. Carry on as if you have\r
+just downloaded and untarred the lastest tarball.\r
+\r
+<P>\r
+If you want to upgrade your current installation then do this ...\r
+\r
+<tscreen><verb>\r
+tar cvfz /tmp/s.tgz spider\r
+cd /\r
+tar xvfzp /tmp/s.tgz\r
+</verb></tscreen>\r
+\r
+This is assuming you downloaded to the /tmp directory of course.\r
+\r
+<P>\r
+NOTE: the 'p' on the end of the 'xvfz' is IMPORTANT! It keeps the permissions\r
+correct. YOU WERE LOGGED IN AS THE USER SYSOP WEREN'T YOU?????\r
+\r
+Remember to recompile the C client (cd /spider/src; make)\r
+\r
+<P>\r
+At this point the files have been upgraded. You can (usually) restart the cluster\r
+in your own time. However, if you attempt to use any new commands or features\r
+expect it to be fatal! At least your cluster will have been restarted then so it\r
+will be too late to worry about it!\r
+\r
+<P>\r
+Now the magic part! From now on when you want to update, simply connect to the\r
+Internet and then, as the user <em>sysop</em> ...\r
+\r
+<tscreen><verb>\r
+cd /spider\r
+cvs -z3 update -d\r
+</verb></tscreen>\r
+\r
+and your files will be updated. As above, remember to recompile the "C" client\r
+if it has been updated (CVS will tell you) and restart if any of the perl scripts\r
+have been altered or added, again, CVS will tell you.\r
+\r
+<P>\r
+You will find any changes documented in the /spider/Changes file.\r
+\r
+<sect1>CVS from a Windows platform\r
+\r
+<P>\r
+After the initial setup, an update to your DXSpider software is no more than a couple\r
+of clicks away. This section is intended to explain and illustrate the use of the\r
+WinCVS application to update your DXSpider software. The current stable version of\r
+WinCVS is Ver. 1.2. You can get this software at:\r
+\r
+<htmlurl url="http://prdownloads.sourceforge.net/cvsgui/WinCvs120.zip" name="http://prdownloads.sourceforge.net/cvsgui/WinCvs120.zip">\r
+\r
+Pick your download mirror and then install WinCVS after the download is complete.\r
+\r
+In this next section I have included a series of links to .jpg files to take advantage of the\r
+picture and 1000 words equivalency. The .jpg files are in the C:\spider\html directory. If\r
+someone using a Linux system is reading this section from boredom, the files are in\r
+/home/sysop/spider/html. One aside, a Linux user can also get a copy of gcvs and do your updates\r
+graphically as opposed to from the command line. The following descriptions are almost identical\r
+between WinCvs and gcvs. The following screen shots have duplicate links, depending upon whether\r
+you are viewing this information under the Windows or Linux operating system.\r
+\r
+When WinCVS is installed, running, and you are connected to the internet, the initial screen looks like:\r
+\r
+<htmlurl url="initial.jpg" name="initial.jpg">\r
+\r
+If you want, you can also look at these .jpg files with another viewer that might provide some\r
+better clarity to the image. On the left is the directory tree for your hard disk. Notice that\r
+the spider directory has a gray highlight.\r
+\r
+To start configuring WinCVS, click on Admin at the top of the screen and then Preferences. This \r
+should get you:\r
+\r
+<htmlurl url="pref-gen.jpg" name="pref-gen.jpg">\r
+\r
+In the top line for CVSROOT, enter:\r
+<tscreen><verb>\r
+anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login\r
+</verb></tscreen>\r
+\r
+and select\r
+<tscreen><verb>\r
+"passwd" file on the cvs server\r
+</verb></tscreen>\r
+\r
+for Authentication on the General tab.\r
+\r
+Next, move to the right to the Ports tab.\r
+\r
+<htmlurl url="pref-ports.jpg" name="pref-ports.jpg">\r
+\r
+In here, check the box on the second line down for the "pserver" port. Enter a port number of 2401.\r
+\r
+Finally, go to the WinCvs tab all the way to the right.\r
+\r
+<htmlurl url="pref-wincvs.jpg" name="pref-wincvs.jpg">\r
+\r
+Enter Notepad as the viewer to open files. For the HOME folder, put "C:\spider" and click OK\r
+because the configuration is now complete.\r
+\r
+You are now ready to upgrade your copy of DXSpider. Click on the greyed Spider folder\r
+shown in the directory tree on the left of the WinCVS display. Two things should happen. The Spider\r
+folder will be selected and the greyed-out arrow located just below the word Query in the top line will\r
+turn to solid green.\r
+\r
+For anyone using gcvs under Linux, the green arrow is located on the extreme left of the display,\r
+under the word File. A gcvs screen looks like:\r
+\r
+<htmlurl url="gcvs.jpg" name="gcvs.jpg">\r
+\r
+Click on the now green arrow to start the download process. An Update Settings box will be displayed\r
+to which you can simply say OK.\r
+\r
+<htmlurl url="update-OK.jpg" name="update-OK.jpg">\r
+\r
+For future reference, the Update Settings box is the place where you can enter information to revert\r
+to a prior version of DXSpider. Information on reverting to a Before Date is contained in the WinCVS\r
+manual.\r
+\r
+After a short period of time, a series of file names will scroll by in the lower pane of the WinCVS\r
+window. Eventually you should see\r
+<tscreen><verb>\r
+*****CVS exited normally with code 0*****\r
+\r
+</verb></tscreen>\r
+appear in the lower pane. You're done. The updated files are in place ready for you to stop and then\r
+restart your DXSpider. After the restart, you're running with the latest version of DXSpider.\r
+\r
+<htmlurl url="completed.jpg" name="completed.jpg">\r
+\r
+To paraphrase from the CVS section... Now the magic part! From now on when you want to update, simply\r
+connect to the Internet and start WinCVS.\r
+<tscreen><verb>\r
+Click on the greyed-out Spider directory in the left screen\r
+Click on the green down arrow\r
+Click OK on the Update Settings dialog box\r
+Restart your Spider software\r
+</verb></tscreen>\r
+\r
+<sect>The DXSpider Command Reference\r
+\r
projects / spider.git / blobdiff