Add section on mail to manual. Added adminmanual-12.html
[spider.git] / sgml / adminmanual.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4
5 <!-- Title information -->
6
7 <title>The DXSpider Installation and Administration Manual 
8 <author>Ian Maude, G0VGS, (ianmaude@btinternet.com)
9 <date>Version 1.31 January 2001
10 <abstract>
11 A reference for SysOps of the DXSpider DXCluster program.
12 </abstract>
13
14 <!-- Table of contents -->
15 <toc>
16
17 <!-- Begin the document -->
18
19 <sect>Installation (Original version by Iain Phillips, G0RDI)
20
21 <sect1>Introduction
22
23 <P>
24 This section describes the installation of DX Spider v1.35 on a 
25 <htmlurl url="http://www.redhat.com" name="RedHat"> Linux Distribution.  
26 I do not intend to try and cover the installation of Linux or the setup 
27 of the AX25 utilities.  If you need help on this then read Iains original 
28 HOWTO on the <htmlurl url="http://www.dxcluster.org" name="DXSpider"> 
29 website.
30
31 <P>
32 I am assuming a general knowledge of Linux and its commands.  You should 
33 know how to use <em>tar</em> and how to edit files using your favourite editor.
34
35 <P>
36 The crucial ingredient for all of this is 
37 <htmlurl url="http://www.perl.org" name="Perl 5.004">.  Now I know Perl 5.005 
38 is out and this will almost certainly work with it, but 
39 <htmlurl url="http://www.redhat.com" name="RedHat 5.1"> comes with 5.004. 
40 <em>Be Warned</em>, earlier versions of 
41 <htmlurl url="http://www.redhat.com" name="RedHat"> <bf>do not</bf> come 
42 with 5.004 as standard, you need to 
43 <htmlurl url="ftp://upgrade.redhat.com" name="upgrade">
44
45 <P>In addition to the standard Red Hat distribution you will require the 
46 following <htmlurl url="http://www.cpan.org/CPAN.html" name="CPAN"> modules: -
47
48 <P>
49 <itemize>
50
51 <item>          MD5-1.7.tar.gz
52 <item>          Data-Dumper-2.10.tar.gz
53 <item>          FreezeThaw-0.3.tar.gz
54 <item>          MLDBM-2.00.tar.gz
55 <item>          TimeDate-1.08.tar.gz
56 <item>          IO-1.20.tar.gz
57 <item>          Net-Telnet-3.02.tar.gz
58 <item>          Curses-1.05.tar.gz
59 <item>          Time-HiRes-01.20.tar.gz
60
61 </itemize>
62
63 <P>
64
65 <em>Do</em> get the latest versions of these packages and install them 
66 but use the above list as the earliest versions usable.
67
68 <sect1>Preparation
69
70 <P>
71 I will assume that you have already downloaded the latest tarball of 
72 the DXSpider software and are ready to install it. I am assuming version 
73 1.35 for this section but of course you would use the latest version.
74
75 <P>
76 Login as root and create a user to run the cluster under.  <bf><it>UNDER 
77 NO CIRCUMSTANCES USE ROOT AS THIS USER!</it></bf>.  I am going to use 
78 the name <em>sysop</em>.  You can call it anything you wish.  Depending 
79 on your security requirements you may wish to use an existing user, 
80 however this is your own choice.
81
82 <P>
83 <tscreen><verb>
84 # adduser -m sysop
85 </verb></tscreen>
86
87 <P>
88 Now set a password for the user ...
89
90 <tscreen><verb>
91 # passwd sysop
92 # New UNIX password:
93 # Retype new UNIX password:
94 passwd: all authentication tokens updated successfully
95 </verb></tscreen>
96
97 <sect1>Installing the software
98
99 <P>
100 Now to unpack the DX Spider distribution, set symbolic links and group 
101 permissions.  Copy the tarball to /home/sysop and do the following.
102
103 <tscreen><verb>
104 # cd ~sysop
105 # tar xvfz spider-1.35.tar.gz
106 # ln -s ~sysop/spider /spider
107 # groupadd -g 251 spider       (or another number)
108 </verb></tscreen>
109
110 If you do not have the command <em>groupadd</em> available to you simply 
111 add a line in /etc/group by hand.
112
113 <tscreen><verb>
114 # vi /etc/group                (or your favorite editor)
115 </verb></tscreen>
116
117 You also need to add some others to the group, including your own callsign 
118 (this will be used as an alias) and root.  The finished line in /etc/group 
119 should look something like this
120
121 <tt>
122 spider:x:251:sysop,g0vgs,root
123 </tt>
124
125 <P>
126 The next step is to set the permissions on the Spider directory tree and files ....
127
128 <tscreen><verb>
129 # chown -R sysop.spider spider
130 # find . -type d -exec chmod 2775 {} \;
131 # find . -type f -exec chmod 775 {} \;
132 </verb></tscreen>
133
134 <P>
135 This last step allows various users of the group <em>spider</em> to have 
136 write access to all the directories.  This is not really needed just yet 
137 but will be useful when web interfaces start to appear.
138
139 <P>
140 Finally, you need to fix the permissions on the ax25_call and netrom_call 
141 programs.  Check where they are with the <em>locate</em> command and alter 
142 the permissions with the <em>chmod</em> command like this ..
143
144 <tscreen><verb>
145 # chown root ax25_call netrom_call
146 # chmod 4775 ax25_call netrom_call
147 </verb></tscreen>
148
149 <sect1>Setting callsigns etc
150
151 <P>
152 Now login to your machine as the user you created earlier.  In my case that 
153 user is called <em>sysop</em>.  Once logged in, issue the following commands ....
154
155 <tscreen><verb>
156 $ cd /spider
157 $ mkdir local
158 $ mkdir local_cmd
159 $ cp perl/DXVars.pm.issue local/DXVars.pm
160 $ cd local
161 $ vi DXVars.pm (or your favourite editor)
162 </verb></tscreen>
163
164 <P>
165 Using the distributed DXVars.pm as a a template, set your cluster callsign, 
166 sysop callsign and other user info to suit your own environment. Note that 
167 this a perl file which will be parsed and executed as part of the cluster. If 
168 you get it wrong then perl will complain when you start the cluster process.  
169 It is important only to alter the text of any section.  Some of the lines look 
170 a little odd.  Take this line for example ....
171
172 <tt>
173 $myemail = "ianmaude\@btinternet.com";
174 </tt>
175
176 <P>
177 There appears to be an extra slash in there.  However this has to be there 
178 for the file to work so leave it in.
179                 
180 <P><bf>PLEASE USE CAPITAL LETTERS FOR CALLSIGNS</bf>
181                 
182 <P>
183 DON'T alter the DXVars.pm (or any other file) in /spider/perl, they are 
184 overwritten with every release. Any files or commands you place in /spider/local 
185 or /spider/local_cmd will automagically be used in preference to the ones in 
186 /spider/perl EVEN while the cluster is running!
187
188 <P>
189 Save the new file and change directory to ../perl ....
190
191 <tscreen><verb>
192 $ cd ../perl
193 </verb></tscreen>
194
195 <P>
196 Now type the following command which creates the basic user file with you as 
197 the sysop.
198
199 <tscreen><verb>
200 $ create_sysop.pl
201 </verb></tscreen>
202
203 <sect1>Starting up for the first time
204
205 <P>
206 We can now bring spider up for the first time and see if all is well or not!  
207 It should look something like this ...
208
209 <tscreen><verb>
210 $ cluster.pl
211 DXSpider DX Cluster Version 1.35
212 Copyright (c) 1998 Dirk Koopman G1TLH
213 loading prefixes ...
214 loading band data ...
215 loading user file system ...
216 starting listener ...
217 reading existing message headers
218 reading cron jobs
219 orft we jolly well go ...
220 </verb></tscreen>
221
222 <P>
223 If all is well then login on another term or console as <em>sysop</em> and 
224 cd to /spider/perl.  Now issue the following command ...
225
226 <tscreen><verb>
227 $ client.pl
228 </verb></tscreen>
229
230 <P>
231 This should log you into the cluster as the sysop under the alias callsign we 
232 set earlier.  In this case the callsign is G0VGS.  The cluster callsign is set 
233 in the DXVars.pm file in /spider/local.  In this case we will assume that this 
234 was set as GB7MBC.  You should therefore see this when you login ....
235
236 <tscreen><verb>
237 G0VGS de GB7MBC 19-Nov-1999 2150Z >
238 </verb></tscreen>
239
240 If you do, congratulations!  If not, look over the instructions again, you 
241 have probably missed something out.  You can shut spider down again with the 
242 command ....
243
244 <tscreen><verb>
245 shutdown
246 </verb></tscreen>
247
248 <P>
249 and both the cluster and the client should return to Linux prompts.
250
251 <sect>The Client program
252
253 <P>
254 In earlier versions of Spider, all the processes were Perl scripts.  This 
255 was fine but with a lot of users your computer memory would soon be used up.  
256 To combat this a new client was written in "C".  This client only works for
257 <em>incoming</em> connects at the moment.  Before you can use it though it 
258 has to be "made".  CD to /spider/src and type <em>make</em>.  You 
259 should see the output on your screen and hopefully now have a small C program 
260 called <em>client</em>.  Leave it in this directory.
261
262 <sect>Configuration
263
264 <sect1>Allowing ax25 connects from users
265
266 <P>
267 As stated previously, the aim of this document is not to tell you how to 
268 configure Linux or the ax25 utilities.  However, you do need to add a line 
269 in your ax25d.conf to allow connections to DXSpider for your users.  For
270 each interface that you wish to allow connections on, use the following format ...
271
272 <tscreen><verb>
273 default  * * * * * *  - sysop /spider/src/client client %u ax25
274 </verb></tscreen>
275
276 <sect1>Allowing telnet connects from users
277
278 <P>
279 Allowing telnet connections is quite simple.  Firstly you need to add a line 
280 in /etc/services to allow connections to a port number, like this ....
281
282 <tscreen><verb>
283 spdlogin   8000/tcp     # spider anonymous login port
284 </verb></tscreen>
285
286 Then add a line in /etc/inetd.conf like this ....
287
288 <tscreen><verb>
289 spdlogin stream tcp nowait root /usr/sbin/tcpd /spider/src/client login telnet
290 </verb></tscreen>
291
292 <P>
293 This needs to be added above the standard services such as ftp, telnet etc.  
294 Once this is done, you need to restart inetd like this ....
295
296 <tscreen><verb>
297 killall -HUP inetd
298 </verb></tscreen>
299
300
301 <P>Now login as <em>sysop</em> and cd spider/perl. You can test that spider 
302 is accepting telnet logins by issuing the following command ....
303
304 <tscreen><verb>
305 client.pl login telnet
306 </verb></tscreen>
307
308 You should get a login prompt and on issuing a callsign, you will be given 
309 access to the cluster.  Note, you will not get a password login.  There seems 
310 no good reason for a password prompt to be given so it is not asked for.
311
312 <P>
313 Assuming all is well, then try a telnet from your linux console ....
314
315 <tscreen><verb>
316 telnet localhost 8000
317 </verb></tscreen>
318
319 <P>
320 You should now get the login prompt and be able to login as before.
321
322 <sect1>Setting up node connects
323
324 <P>
325 In order to allow cluster node connections, spider needs to know that the 
326 connecting callsign is a cluster node.  This is the case whether the connect 
327 is incoming or outgoing.  In spider this is a simple task and can be done in 
328 runtime.
329
330 <P>
331 Later versions of Spider can distinguish different software and treat them
332 differently.  For example, the WCY beacon cannot be handles by AK1A type
333 nodes as AK1A does not know what to do with PC73.  There are 4 different
334 types of node at present and although they may not have any major
335 differences at the moment, it allows for compatibility.  The 4 types are ...
336
337 <tscreen><verb>
338 set/node        (AK1A type)
339 set/spider
340 set/dxnet
341 set/clx
342 </verb></tscreen>
343
344 <P>
345 For now, we will assume that the cluster we are going to connect to is an
346 AK1A type node.
347
348 <P>
349 Start up the cluster as you did before and login as the sysop with client.pl.
350 The cluster node I am wanting to make a connection to is GB7BAA but you would
351 obviously use whatever callsign you required.  At the prompt type ...
352
353 <tscreen><verb>
354 set/node gb7baa
355 </verb></tscreen>
356
357 <P>
358 The case does not matter as long as you have a version of DXSpider later than 
359 1.33.  Earlier versions required the callsign to be in upper case.
360
361 <P>
362 That is now set, it is as simple as that.  To prove it, login on yet another 
363 console as sysop and issue the command ...
364
365 <tscreen><verb>
366 client.pl gb7baa (using the callsign you set as a node)
367 </verb></tscreen>
368
369 <P>
370 You should get an initialisation string from DXSpider like this ...
371
372 <tscreen><verb>
373 client.pl gb7baa
374 PC38^GB7MBC^~
375 </verb></tscreen>
376
377 If the callsign you just set up as a cluster node is for an incoming connect, 
378 this is all that needs to be done.  If the connection is to be outgoing then 
379 a connection script needs to be written.
380
381 <sect1>Connection scripts
382
383 <P>
384 Because DXSpider operates under Linux, connections can be made using just about 
385 any protocol;  AX25, NETRom, tcp/ip, ROSE etc are all possible examples.  
386 Connect scripts live in the /spider/connect directory and are simple ascii files.  
387 Writing a script for connections is therefore relatively simple.  
388
389 <P>
390 The connect scripts consist of lines which start with the following keywords 
391 or symbols:-
392
393 <verb>
394         
395 #               All lines starting with a # are ignored, as are completely 
396                 blank lines.
397
398 timeout         timeout followed by a number is the number of seconds to wait for a 
399                 command to complete. If there is no timeout specified in the script 
400                 then the default is 60 seconds.
401
402 abort           abort is a regular expression containing one or more strings to look 
403                 for to abort a connection. This is a perl regular expression and is 
404                 executed ignoring case.
405
406 connect         connect followed by ax25 or telnet and some type dependent 
407                 information. In the case of a telnet connection, there can be up to 
408                 two parameters.
409                 The first is the ip address or hostname of the computer you wish to 
410                 connect to and the second is the port number you want to use (this 
411                 can be left out if it is a normal telnet session).
412                 In the case of an ax25 session then this would normally be a call to
413                 ax25_call or netrom_call as in the example above. It is your
414                 responsibility to get your node and other ax25 parameters to work 
415                 before going down this route!
416
417 '               ' is the delimiting character for a word or phrase of an expect/send 
418                 line in a chat type script. The words/phrases normally come in pairs,
419                 either can be empty. Each line reads input from the connection until 
420                 it sees the string (or perl regular expression) contained in the
421                 left hand string. If the left hand string is empty then it doesn't 
422                 read or wait for anything. The comparison is done ignoring case.
423                 When the left hand string has found what it is looking for (if it is)
424                 then the right hand string is sent to the connection.
425                 This process is repeated for every line of chat script. 
426
427 client          client starts the connection, put the arguments you would want here 
428                 if you were starting the client program manually. You only need this 
429                 if the script has a different name to the callsign you are trying to 
430                 connect to (i.e. you have a script called other which actually 
431                 connects to GB7DJK-1 [instead of a script called gb7djk-1]).
432 </verb>
433
434
435 There are many possible ways to configure the script but here are two examples, 
436 one for a NETRom/AX25 connect and one for tcp/ip.  
437
438 <tscreen><verb>
439 timeout 60
440 abort (Busy|Sorry|Fail)
441 # don't forget to chmod 4775 netrom_call!
442 connect ax25 /usr/sbin/netrom_call bbs gb7djk g1tlh
443 'Connect' '' 
444 'Connect' 'c np7'
445 'Connect' 'c gb7dxm'
446 # you can leave this out if you call the script 'gb7dxm'
447 client gb7dxm ax25
448 </verb></tscreen>
449
450 <P>
451
452 <tscreen><verb>
453 timeout 15
454 connect telnet dirkl.tobit.co.uk
455 'login' 'gb7djk'
456 'word' 'gb7djk'
457 # tell GB7DJK-1 that it is connected to GB7DJK
458 # you can leave this out if you call this script 'gb7djk'
459 client gb7djk telnet
460 </verb></tscreen>
461
462 <P>
463 Both these examples assume that everything is set up properly at the other end.  
464 You will find other examples in the /spider/examples directory.
465
466 <sect1>Starting the connection
467
468 <P>
469 You start the connection, from within a sysop enabled cluster login, by typing 
470 in the word <em>connect</em> followed by a script name like this ....
471
472 <tscreen><verb>
473 G0VGS de GB7MBC 13-Dec-1998 2041Z >connect gb7djk-1
474 connection to GB7DJK-1 started
475 G0VGS de GB7MBC 13-Dec-1998 2043Z >
476 </verb></tscreen>
477
478 This will start a connection using the script called <em>gb7djk-1</em>.  You can
479 follow the connection by watching the term or console from where you started
480 <em>cluster.pl</em>.  You should see something like this ...
481
482 <tscreen><verb>
483 <- D G1TLH connect gb7djk-1
484 -> D G1TLH connection to GB7DJK-1 started
485 -> D G1TLH G1TLH de GB7DJK 13-Dec-1998 2046Z >
486 timeout set to 15
487 CONNECT sort: telnet command: dirkl.tobit.co.uk
488 CHAT "login" -> "gb7djk"
489 received "
490 Red Hat Linux release 5.1 (Manhattan)
491 Kernel 2.0.35 on an i586
492 "
493 received "login: "
494 sent "gb7djk"
495 CHAT "word" -> "gb7djk"
496 received "gb7djk"
497 received "Password: "
498 sent "gb7djk"
499 Connected to GB7DJK-1, starting normal protocol
500 <- O GB7DJK-1 telnet
501 -> B GB7DJK-1 0
502 GB7DJK-1 channel func  state 0 -> init
503 <- D GB7DJK-1 
504 <- D GB7DJK-1 Last login: Sun Dec 13 17:59:56 from dirk1
505 <- D GB7DJK-1 PC38^GB7DJK-1^~
506 <- D GB7DJK-1 PC18^ 1 nodes, 0 local / 1 total users  Max users 0  Uptime 
507 0 00:00^5447^~
508     etc
509
510 </verb></tscreen>
511
512 <P>
513 With later versions of Spider there is a set/login command for users.  This 
514 tells them when a user or node logs in or out.  If you do not add a line to 
515 your scripts after the final line (or before the client line which should always 
516 be last if needed) then the login/logout information will be sent to users
517 <it>before</it> the login actually completes.  This means if a node is 
518 unreachable, it will continue sending logins and logouts to users even though it 
519 is not actually connecting.  To avoid this use the following line ...
520
521 <tscreen><verb>
522 'connect' ''
523 </verb></tscreen>
524
525 <P>
526 In a script, this might look like ...
527
528 <tscreen><verb>
529 timeout 35 
530 abort (Busy|Sorry|Fail)
531 connect telnet mary 3000
532 'ogin:' 'gb7mbc'
533 '>' 'telnet 44.131.93.96 7305'
534 'connect' ''
535 </verb></tscreen>
536
537 <sect1>Telnet echo
538
539 <P>
540 Cluster links in particular suffer greatly from the presence of telnet echo.  
541 This is caused by the telnet negotiation itself and can create at worst severe 
542 loops.  At best it creates unnecessary bandwidth and large logfiles!  There are
543 things that can be done to limit this problem but will not always work dependent 
544 on the route taken to connect.
545
546 <P>
547 Telnet echo itself should only be a problem if the connection is being made to 
548 the telnet port (23).  This port uses special rules that include echo negotiation.
549 If the connection is to a different port, such as 8000, this negotiation does 
550 not happen and therefore no echo should be present.
551
552 <P>
553 Sometimes it is not possible to make a direct connection to another node and this 
554 can cause problems.  There is a way of trying to suppress the telnet echo but 
555 this will not always work, unfortunately it is difficult to be more specific.  
556 Here is an example of what I mean ...
557
558 <tscreen><verb>
559 timeout 35
560 abort (Busy|Sorry|Fail)
561 connect telnet mary.lancs.ac.uk
562 'ogin:' 'gb7mbc'
563 'word:' 'mypasswd'
564 '\$' 'stty -echo raw'
565 '\$' 'telnet 44.131.93.96'
566 'connect' ''
567 </verb></tscreen>
568
569 So, the first connection is made by Spider.  This is fine as Spider uses the
570 Net_Telnet script from within perl.  This actually uses TCP rather than TELNET 
571 so no negotiation will be done on the first connection.  Once connected to
572 mary.lancs.ac.uk, the command is sent to suppress echo.  Now a telnet is made 
573 to a cluster node that is accepting connections on port 23.  The problem with 
574 this link is that the negotiation is made by the remote machine, therefore you 
575 have no control over it.  The chances are that this link will create echo and 
576 there will be no way you can stop it.
577
578
579 <sect>Automating things
580
581 <P>
582 Ok, you should now have DXSpider running nicely and allowing connects by cluster
583 nodes or users.  However, it has to be shutdown and restarted manually and if
584 connection scripts fail they have to be started again manually too, not much use 
585 if you are not at the console!  So, in this section we will automate both.  
586 Firstly starting the cluster.
587
588 <sect1>Autostarting the cluster
589
590 <P>
591 This is not only a way to start the cluster automatically, it also works as a
592 watchdog, checking the sanity of DXSpider and respawning it should it crash for 
593 any reason.  Before doing the following, shutdown the cluster as you did earlier.
594
595 <P>
596 Login as root and bring up the /etc/inittab file in your favourite editor.  Add 
597 the following lines to the file near the end ...
598
599 <tscreen><verb>
600 ##Start DXSpider on bootup and respawn it should it crash
601 DX:3:respawn:/bin/su -c "/usr/bin/perl -w /spider/perl/cluster.pl" sysop >/dev/tty7
602 </verb></tscreen>
603
604 <P>
605 This will automatically start DXSpider on tty7 (ALT-F7) on bootup and restart 
606 it should it crash for any reason.
607
608 <P>
609 As root type the command <em>telinit q</em>.  DXSpider should start up 
610 immediately.  You will see the output on tty7 and if you login as <em>sysop</em> 
611 you should find everything running nicely.
612
613 <P>
614 So far so good, now to automate script connections...
615
616 <sect1>The crontab file
617
618 <P>
619 Login as <em>sysop</em> and create a file in /spider/local_cmd called crontab.  
620 Edit it with your favourite editor and add a line like this (I have included 
621 a comment)
622
623 <tscreen><verb>
624 # check every 10 minutes to see if gb7xxx is connected and if not
625 # start a connect job going
626
627 0,10,20,30,40,50 * * * * start_connect('gb7xxx') if !connected('gb7xxx')
628 </verb></tscreen>
629
630 <P>
631 The callsign involved will be the callsign of the cluster node you are 
632 going to connect to.  This will now check every 10 minutes to see if 
633 gb7xxx is connected, if it is then nothing will be done.  If it is not, 
634 then a connect attempt will be started.
635
636 <P>
637 There are probably lots of other things you could use this crontab file for.  
638 If you want to know more about it, look at the
639 <htmlurl url="http://www.dxcluster.org/cron.html" name="DXSpider"> website 
640 at the cron page where it is explained more fully.
641
642 <sect>Hop control
643
644 <P>
645 Starting with version 1.13 there is simple hop control available on a per
646 node basis. Also it is possible to isolate a network completely so that you 
647 get all the benefits of being on that network, but can't pass on information
648 from it to any other networks you may be connected to (or vice versa).
649
650 <sect1>Basic hop control
651
652 <P>
653 In /spider/data you will find a file called hop_table.pl.  This is the file 
654 that controls your hop count settings.  It has a set of default hops on the 
655 various PC frames and also a set for each node you want to alter the hops for.  
656 You may be happy with the default settings of course, but this powerful tool 
657 can help to protect and improve the network.  The file will look something 
658 like this ...
659
660 <tscreen><verb>
661
662 # hop table construction
663
664
665 package DXProt;
666
667 # default hopcount to use
668 $def_hopcount = 5;
669
670 # some variable hop counts based on message type
671 %hopcount = 
672 (
673  11 => 10,
674  16 => 10,
675  17 => 10,
676  19 => 10,
677  21 => 10,
678 );
679
680
681 # the per node hop control thingy
682
683
684 %nodehops = 
685
686  GB7ADX => {            11 => 8,
687                         12 => 8,
688                         16 => 8,
689                         17 => 8,
690                         19 => 8,
691                         21 => 8,
692                    },
693
694  GB7UDX => {            11 => 8,
695                         12 => 8,
696                         16 => 8,
697                         17 => 8,
698                         19 => 8,
699                         21 => 8,
700                    },
701  GB7BAA => {
702                         11 => 5,
703                         12 => 8,
704                         16 => 8,
705                         17 => 8,
706                         19 => 8,
707                         21 => 8,
708                    },
709 };
710 </verb></tscreen>
711
712 <P>
713 Each set of hops is contained within a pair of curly braces and contains a 
714 series of PC frame types.  PC11 for example is a DX spot. The figures here 
715 are not exhaustive but should give you a good idea of how the file works.
716
717 <P>
718 You can alter this file at any time, including whilst the cluster is running.  
719 If you alter the file during runtime, the command <em>load/hops</em> will 
720 bring your changes into effect.
721
722 <sect1>Isolating networks
723
724 <P>
725 It is possible to isolate networks from each other on a "gateway" node using the
726  <em>set/isolate &lt;node_call&gt;</em> command.
727         
728 <P>
729 The effect of this is to partition an isolated network completely from another 
730 nodes connected to your node. Your node will appear on and otherwise behave 
731 normally on every network to which you are connected, but data from an isolated 
732 network will not cross onto any other network or vice versa. However all the 
733 spot, announce and WWV traffic and personal messages will still be handled 
734 locally (because you are a real node on all connected networks), that is locally
735 connected users will appear on all networks and will be able to access and 
736 receive information from all networks transparently.  All routed messages will 
737 be sent as normal, so if a user on one network knows that you are a gateway for 
738 another network, he can still still send a talk/announce etc message via your 
739 node and it will be routed across.
740
741 <P>
742 The only limitation currently is that non-private messages cannot be passed down 
743 isolated links regardless of whether they are generated locally. This will change 
744 when the bulletin routing facility is added.
745
746 <P>
747 If you use isolate on a node connection you will continue to receive all 
748 information from the isolated partner, however you will not pass any information 
749 back to the isolated node.  There are times when you would like to forward only 
750 spots across a link (maybe during a contest for example).  To do this, isolate 
751 the node in the normal way and put in a filter in the /spider/filter/spots 
752 directory to override the isolate.  This filter can be very simple and consists 
753 of just one line ....
754
755 <tscreen><verb>
756 $in = [
757         [ 1, 0, 'd', 0, 3]      # The last figure (3) is the hop count
758 ];
759 </verb></tscreen>
760
761 <P>
762 There is a lot more on filtering in the next section.
763
764 <sect>Filtering (Old Style upto v1.44)
765
766 <P>
767 Filters can be set for spots, announcements and WWV.  You will find the 
768 directories for these under /spider/filter.  You will find some examples in 
769 the directories with the suffix <em>.issue</em>.  There are two types of 
770 filter, one for incoming information and one for outgoing information. 
771 Outgoing filters are in the form <em>CALLSIGN.pl</em> and incoming filters 
772 are in the form <em>in_CALLSIGN.pl</em>.  Filters can be set for both nodes 
773 and users.
774
775 <P>
776 All filters work in basically the same way.  There are several elements 
777 delimited by commas.  There can be many lines in the filter and they are 
778 read from the top by the program.  When writing a filter you need to think 
779 carefully about just what you want to achieve.  You are either going to write 
780 a filter to <em>accept</em> or to <em>reject</em>.  Think of a filter as 
781 having 2 main elements.  For a reject filter, you would have a line or multiple 
782 lines rejecting the things you do not wish to receive and then a default line
783 accepting everything else that is not included in the filter.  Likewise, for an
784 accept filter, you would have a line or multiple lines accepting the things you 
785 wish to receive and a default line rejecting everthing else.
786
787 <P>
788 In the example below, a user requires a filter that would only return SSB spots
789 posted in Europe on the HF bands.  This is achieved by first rejecting the CW 
790 section of each HF band and rejecting all of VHF, UHF etc based on frequency.
791 Secondly, a filter rule is set based on CQ zones to only accept spots posted in
792 Europe.  Lastly, a default filter rule is set to reject anything outside the filter.
793
794 <tscreen><verb>
795 $in = [
796         [ 0, 0, 'r', # reject all CW spots
797                 [
798                 1800.0, 1850.0,
799                 3500.0, 3600.0,
800                 7000.0, 7040.0,
801                 14000.0, 14100.0,
802                 18068.0, 18110.0,
803                 21000.0, 21150.0,
804                 24890.0, 24930.0,
805                 28000.0, 28180.0,
806                 30000.0, 49000000000.0,
807                 ] ,1 ],
808         [ 1, 11, 'n', [ 14, 15, 16, 20, 33, ], 15 ], #accept EU
809         [ 0, 0, 'd', 0, 1 ], # 1 = want, 'd' = everything else
810 ];
811 </verb></tscreen>
812
813 <P>
814 The actual elements of each filter are described more fully in the following
815 sections.
816
817 <sect1>Spots
818
819 <P>
820 The elements of the Spot filter are ....
821
822 <tscreen><verb>
823 [action, field_no, sort, possible_values, hops]
824 </verb></tscreen>
825
826 <P>
827 There are 3 elements here to look at.  Firstly, the action element.  This is 
828 very simple and only 2 possible states exist, accept (1) or drop (0).
829
830 <P>
831 The second element is the field_no.  There are 13 possiblities to choose from 
832 here ....
833
834 <tscreen><verb>
835       0 = frequency
836       1 = call
837       2 = date in unix format
838       3 = comment
839       4 = spotter
840       5 = spotted dxcc country
841       6 = spotter's dxcc country
842       7 = origin
843       8 = spotted itu
844       9 = spotted cq
845       10 = spotter's itu
846       11 = spotter's cq
847       12 = callsign of the channel on which the spot has appeared
848 </verb></tscreen>
849
850 <P>
851 The third element tells us what to expect in the fourth element.  There are 
852 4 possibilities ....
853
854 <tscreen><verb>
855      n - numeric list of numbers e.g. [ 1,2,3 ]
856      r - ranges of pairs of numbers e.g. between 2 and 4 or 10 to 17 - [ 2,4, 10,17 ]
857      a - an alphanumeric regex
858      d - the default rule
859 </verb></tscreen>
860
861 <P>
862 The fifth element is simply the hops to set in this filter.  This would only 
863 be used if the filter was for a node of course and overrides the hop count in
864 hop_table.pl.
865
866 <P>
867 So, let's look at an example spot filter.  It does not matter in the example 
868 who the filter is to be used for.  So, what do we need in the filter?  We need 
869 to filter the spots the user/node requires and also set a default rule for 
870 anything else outside the filter.  Below is a simple filter that stops spots 
871 arriving from outside Europe.
872
873 <tscreen><verb>$in = [
874   [ 0, 4, 'a', '^(K|N|A|W|VE|VA|J)'],  # 0 = drop, 'a' = alphanumeric
875   [ 1, 0, 'd', 0, 1 ],                 # 1 = want, 'd' = everything else
876                      ];
877 </verb></tscreen>
878
879 <P>
880 So the filter is wrapped in between a pair of square brackets.  This tells 
881 Spider to look in between these limits.  Then each line is contained within 
882 its own square brackets and ends with a comma. Lets look carefully at the first 
883 line.  The first element is 0 (drop).  Therefore anything we put on this line 
884 will not be accepted.  The next element is 4.  This means we are filtering by 
885 the spotter.  The third element is the letter "a" which tells the program to 
886 expect an alphanumeric expression in the fourth element.  The fourth element 
887 is a list of letters separated by the pipe symbol.
888
889 <P>
890 What this line does is tell the program to drop any spots posted by anyone in 
891 the USA, Canada or Japan.
892
893 <P>
894 The second line is the default rule for anything else.  The "d" tells us this 
895 and the line simply reads... accept anything else.
896
897 <P>
898 You can add as many lines as you need to complete the filter but if there are 
899 several lines of the same type it is neater to enclose them all as one line.  
900 An example of this is where specific bands are set.  We could write this like 
901 this ....
902
903 <tscreen><verb>
904 [ 0,0,'r',[1800.0, 2000.0], 1],
905 [ 0,0,'r',[10100.0, 10150.0], 1],
906 [ 0,0,'r',[14000.0, 14350.0], 1],
907 [ 0,0,'r',[18000.0, 18200.0], 1],
908 </verb></tscreen>
909
910 <P>
911 But the line below achieves the same thing and is more efficient ....
912
913 <tscreen><verb>
914   [ 0, 0, 'r',
915     [  
916       1800.0, 2000.0,         # top band 
917       10100.0, 10150.0,       # WARC  
918       14000.0, 14350.0,       # 20m
919       18000.0, 18200.0,       # WARC
920     [ ,1 ],
921 </verb></tscreen>
922
923
924 <sect1>Announcements
925
926 <P>
927 <tscreen><verb>
928
929 # This is an example announce or filter allowing only West EU announces
930
931 # The element list is:-
932 # 0 - callsign of announcer
933 # 1 - destination * = all, <callsign> = routed to the node
934 # 2 - text
935 # 3 - * - sysop, <some text> - special list eg 6MUK, ' ', normal announce
936 # 4 - origin
937 # 5 - 0 - announce, 1 - wx
938 # 6 - channel callsign (the interface from which this spot came)
939
940 $in = [
941         [ 1, 0, 'a', '^(P[ABCDE]|DK0WCY|G|M|2|EI|F|ON)' ],
942         [ 0, 0, 'd', 0 ]
943 ];
944 </verb></tscreen>
945
946 In this example, only the prefixes listed will be allowed.  It is possible to 
947 be quite specific.  The Dutch prefix "P" is followed by several secondary 
948 identifiers which are allowed.  So, in the example, "PA" or "PE" would be ok 
949 but not "PG".  It is even possible to allow information from a single callsign.  
950 In the example this is DK0WCY, to allow the posting of his Aurora Beacon.
951
952 <sect1>WWV
953
954 <P>
955 <tscreen><verb>
956
957 # This is an example WWV filter
958
959 # The element list is:-
960 # 0 - nominal unix date of spot (ie the day + hour:13)
961 # 1 - the hour
962 # 2 - SFI
963 # 3 - K
964 # 4 - I
965 # 5 - text
966 # 6 - spotter
967 # 7 - origin
968 # 8 - incoming interface callsign
969
970 # this one doesn't filter, it just sets the hop count to 6 and is
971 # used mainly just to override any isolation from WWV coming from
972 # the internet.
973
974 $in = [
975         [ 1, 0, 'd', 0, 6 ]
976 ];
977
978 </verb></tscreen>
979
980 <P>
981 It should be noted that the filter will start to be used only once a user/node 
982 has logged out and back in again.
983 <P>
984 I am not going to spend any more time on these filters now as they will become 
985 more "comprehensive" in the near future.
986
987 <sect>Filtering (New Style v1.45 and later)
988
989 <sect1>General filter rules
990
991 <P>
992 Upto v1.44 it was not possible for the user to set their own filters.  From 
993 v1.45 though that has all changed.  It is now possible to set filters for just 
994 about anything you wish.  If you have just updated from an older version of 
995 DXSpider you will need to update your new filters.  You do not need to do 
996 anything with your old filters, they will be renamed as you update.
997
998 <P>
999 There are 3 basic commands involved in setting and manipulating filters.  These 
1000 are <em>accept</em>, <em>reject</em> and <em>clear</em>.  First we will look
1001 generally at filtering. There are a number of things you can filter in the 
1002 DXSpider system. They all use the same general mechanism.
1003
1004 <P>
1005 In general terms you can create a 'reject' or an 'accept' filter which can have 
1006 up to 10 lines in it. You do this using, for example ... 
1007
1008 <tscreen><verb> 
1009 accept/spots .....
1010 reject/spots .....
1011 </verb></tscreen>
1012
1013 where ..... are the specific commands for that type of filter. There are filters 
1014 for spots, wwv, announce, wcy and (for sysops) connects. See each different 
1015 accept or reject command reference for more details.
1016
1017 There is also a command to clear out one or more lines in a filter. They are ...
1018
1019 <tscreen><verb>
1020 clear/spots 1
1021 clear/spots all
1022 </verb></tscreen>
1023
1024 There is clear/xxxx command for each type of filter.
1025
1026 <P>
1027 and you can check that your filters have worked by the command ... 
1028
1029 <tscreen><verb>  
1030 show/filter
1031 </verb></tscreen>
1032
1033 <P>
1034 For now we are going to use spots for the examples, but you can apply the same
1035 principles to all types of filter.
1036
1037 <sect1>Types of filter
1038
1039 <P>
1040 There are two main types of filter, <em>accept</em> or <em>reject</em>.  You 
1041 can use either to achieve the result you want dependent on your own preference 
1042 and which is more simple to do.  It is pointless writing 8 lines of reject 
1043 filters when 1 accept filter would do the same thing!  Each filter has 10 
1044 lines (of any length) which are tried in order.  If a line matches then the 
1045 action you have specified is taken (ie reject means ignore it and accept 
1046 means take it)
1047
1048 <P>
1049 If you specify reject filters, then any lines that arrive that match the filter 
1050 will be dumped but all else will be accepted.  If you use an accept filter, 
1051 then ONLY the lines in the filter will be accepted and all else will be dumped.
1052 For example if you have a single line <em>accept</em> filter ...
1053
1054 <tscreen><verb>
1055 accept/spots on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
1056 </verb></tscreen>
1057
1058 then you will <em>ONLY</em> get VHF spots <em>from</em> or <em>to</em> CQ zones 
1059 14, 15 and 16.
1060
1061 <P>
1062 If you set a reject filter like this ...
1063
1064 <tscreen><verb>
1065 reject/spots on hf/cw
1066 </verb></tscreen>
1067
1068 Then you will get everything <em>EXCEPT</em> HF CW spots.  You could make this 
1069 single filter even more flexible.  For example, if you are interested in IOTA 
1070 and will work it even on CW even though normally you are not interested in 
1071 CW, then you could say ...
1072
1073 <tscreen><verb>
1074 reject/spots on hf/cw and not info iota
1075 </verb></tscreen>
1076
1077 But in that case you might only be interested in iota and say:-
1078
1079 <tscreen><verb>
1080 accept/spots not on hf/cw or info iota
1081 </verb></tscreen>
1082
1083 which achieves exactly the same thing. You should choose one or the other 
1084 until you are comfortable with the way it works. You can mix them if you 
1085 wish (actually you can have an accept AND a reject on the same line) but 
1086 don't attempt this until you are sure you know what you are doing!
1087
1088 <P>
1089 You can arrange your filter lines into logical units, either for your own
1090 understanding or simply convenience. Here is an example ...
1091
1092 <tscreen><verb>
1093 reject/spots 1 on hf/cw
1094 reject/spots 2 on 50000/1400000 not (by_zone 14,15,16 or call_zone 14,15,16)  
1095 </verb></tscreen>
1096
1097 What this does is to ignore all HF CW spots and also rejects any spots on VHF 
1098 which don't either originate or spot someone in Europe. 
1099
1100 <P>
1101 This is an example where you would use a line number (1 and 2 in this case), if 
1102 you leave the digit out, the system assumes '1'. Digits '0'-'9' are available.  
1103 This make it easier to see just what filters you have set.  It also makes it 
1104 more simple to remove individual filters, during a contest for example.
1105
1106 <P>
1107 You will notice in the above example that the second line has brackets.  Look 
1108 at the line logically.  You can see there are 2 separate sections to it.  We 
1109 are saying reject spots that are VHF or above <em>APART</em> from those in 
1110 zones 14, 15 and 16 (either spotted there or originated there).  If you did 
1111 not have the brackets to separate the 2 sections, then Spider would read it 
1112 logically from the front and see a different expression entirely ...
1113
1114 <tscreen><verb>
1115 (on 50000/1400000 and by_zone 14,15,16) or call_zone 14,15,16 
1116 </verb></tscreen>
1117
1118 The simple way to remember this is, if you use OR - use brackets. Whilst we are 
1119 here CASE is not important. 'And BY_Zone' is just the same as 'and by_zone'.
1120
1121 As mentioned earlier, setting several filters can be more flexible than 
1122 simply setting one complex one.  Doing it in this way means that if you want 
1123 to alter your filter you can just redefine or remove one or more lines of it or 
1124 one line. For example ...
1125
1126 <tscreen><verb>
1127 reject/spots 1 on hf/ssb
1128 </verb></tscreen>
1129
1130 would redefine our earlier example, or 
1131
1132 <tscreen><verb>
1133 clear/spots 1
1134 </verb></tscreen>
1135
1136 To remove all the filter lines in the spot filter ...
1137
1138 <tscreen><verb>
1139 clear/spots all
1140 </verb></tscreen>
1141
1142 <sect1>Filter options
1143
1144 <P>
1145 You can filter in several different ways.  The options are listed in the
1146 various helpfiles for accept, reject and filter.
1147
1148 <sect1>Default filters
1149
1150 <P>
1151 Sometimes all that is needed is a general rule for node connects.  This can
1152 be done with a node_default filter.  This rule will always be followed, even
1153 if the link is isolated, unless another filter is set specifically.  Default
1154 rules can be set for nodes and users.  They can be set for spots, announces,
1155 WWV and WCY.  They can also be used for hops.  An example might look like 
1156 this ...
1157
1158 <tscreen><verb>
1159 accept/spot node_default by_zone 14,15,16,20,33
1160 set/hops node_default spot 50
1161 </verb></tscreen>
1162
1163 This filter is for spots only, you could set others for announce, WWV and WCY.
1164 This filter would work for ALL nodes unless a specific filter is written to 
1165 override it for a particular node.  You can also set a user_default should
1166 you require.  It is important to note that default filters should be
1167 considered to be "connected".  By this I mean that should you override the
1168 default filter for spots, you need to add a rule for the hops for spots also.
1169
1170 <sect1>Advanced filtering
1171
1172 <P>
1173 Once you are happy with the results you get, you may like to experiment. 
1174
1175 <P>
1176 The previous example that filters hf/cw spots and accepts vhf/uhf spots from EU 
1177 can be written with a mixed filter, for example ... 
1178
1179 <tscreen><verb>
1180 rej/spot on hf/cw
1181 acc/spot on 0/30000
1182 acc/spot 2 on 50000/1400000 and (by_zone 14,15,16 or call_zone 14,15,16)
1183 </verb></tscreen>
1184
1185 Note that the first filter has not been specified with a number.  This will 
1186 automatically be assumed to be number 1.  In this case, we have said <em>reject all
1187 HF spots in the CW section of the bands but accept all others at HF.  Also
1188 accept anything in VHF and above spotted in or by operators in the zones
1189 14, 15 and 16</em>.  Each filter slot actually has a 'reject' slot and 
1190 an 'accept' slot. The reject slot is executed BEFORE the accept slot.
1191
1192 <P>
1193 It was mentioned earlier that after a reject test that doesn't match, the default 
1194 for following tests is 'accept', the reverse is true for 'accept'. In the example 
1195 what happens is that the reject is executed first, any non hf/cw spot is passed 
1196 to the accept line, which lets through everything else on HF.  The next filter line 
1197 lets through just VHF/UHF spots from EU.
1198
1199
1200 <sect>Other filters
1201
1202 <sect1>Filtering Mail
1203
1204 <P>
1205 In the /spider/msg directory you will find a file called badmsg.pl.issue.  Rename
1206 this to badmsg.pl and edit the file.  The original looks something like this ....
1207
1208 <tscreen><verb>
1209
1210 # the list of regexes for messages that we won't store having
1211 # received them (bear in mind that we must receive them fully before
1212 # we can bin them)
1213
1214
1215 # The format of each line is as follows
1216
1217 #     type      source             pattern 
1218 #     P/B/F     T/F/O/S            regex  
1219
1220 # type: P - private, B - bulletin (msg), F - file (ak1a bull)
1221 # source: T - to field, F - from field,  O - origin, S - subject 
1222 # pattern: a perl regex on the field requested
1223
1224 # Currently only type B and P msgs are affected by this code.
1225
1226 # The list is read from the top down, the first pattern that matches
1227 # causes the action to be taken.
1228
1229 # The pattern can be undef or 0 in which case it will always be selected
1230 # for the action specified
1231
1232
1233
1234 package DXMsg;
1235
1236 @badmsg = (
1237 'B',    'T',    'SALE', 
1238 'B',    'T',    'WANTED',
1239 'B',    'S',    'WANTED',
1240 'B',    'S',    'SALE', 
1241 'B',    'S',    'WTB',
1242 'B',    'S',    'WTS',
1243 'B',    'T',    'FS',
1244 );
1245 </verb></tscreen>
1246
1247 <P>
1248 I think this is fairly self explanatory.  It is simply a list of subject 
1249 headers that we do not want to pass on to either the users of the cluster or 
1250 the other cluster nodes that we are linked to.  This is usually because of 
1251 rules and regulations pertaining to items for sale etc in a particular country.
1252
1253 <sect1>Filtering DX callouts (Depricated)
1254
1255 <P>
1256 <bf><it>From version 1.47, this method is replaced by the command set/baddx</it></bf>
1257
1258 <P>
1259 In the same way as mail, there are some types of spot we do not wish to pass on 
1260 to users or linked cluster nodes.  In the /spider/data directory you will find 
1261 a file called baddx.pl.issue.  Rename this to baddx.pl and edit the file.  The
1262 original looks like this ....
1263
1264 <tscreen><verb>
1265
1266 # the list of dx spot addresses that we don't store and don't pass on
1267
1268
1269 package DXProt;
1270
1271 @baddx = qw 
1272
1273  FROG 
1274  SALE
1275  FORSALE
1276  WANTED
1277  P1RATE
1278  PIRATE
1279  TEST
1280  DXTEST
1281  NIL
1282  NOCALL 
1283 );
1284 </verb></tscreen>
1285
1286 <P>
1287 Again, this is simply a list of names we do not want to see in the spotted 
1288 field of a DX callout.
1289
1290
1291 <sect1>Filtering words from text fields in Announce, Talk and DX spots
1292
1293 <P>
1294 Create a file in /spider/data called <em>badwords</em>.  The format is quite
1295 simple.  Lines beginning with # are ignored so comments can be added.  An
1296 example file is below ...
1297
1298 <tscreen><verb>
1299 # Below is a list of words we do not wish to see on the cluster
1300 grunge grunged grunging
1301 splodge splodger splodging
1302 grince
1303 fluffle
1304 </verb></tscreen>
1305
1306 Multiple words can be used on the same line as shown.  Obviously these
1307 are just examples :-)
1308
1309 <P>
1310 You can reload the file from the cluster prompt as sysop with load/badwords.
1311
1312 <sect>Mail
1313
1314 <P>
1315 DXSpider deals seamlessly with standard AK1A type mail.  It supports both
1316 personal and bulletin mail and the sysop has additional commands to ensure
1317 that mail gets to where it is meant.  DXSpider will send mail almost
1318 immediately, assuming that the target is on line.  However, only one
1319 mail message is dealt with at any one time.  If a mail message is already
1320 being sent or recieved, then the new message will be queued until it has
1321 finished.
1322
1323 The cluster mail is automatically deleted after 30 days unless the sysop
1324 sets the "keep" flag using the <em>msg</em> command.
1325
1326 <sect1>Personal mail
1327
1328 <P>
1329 Personal mail is sent using the <em>sp</em> command.  This is actually the
1330 default method of sending mail and so a simple <em>s</em> for send will do.
1331 A full list of the send commands and options is in the <em>command set</em>
1332 section, so I will not duplicate them here.
1333
1334 <sect1>Bulletin mail
1335
1336 <P>
1337 Bulletin mail is sent by using the <em>sb</em> command.  This is one of the
1338 most common mistakes users make when sending mail.  They send a bulletin
1339 mail with <em>s</em> or <em>sp</em> instead of <em>sb</em> and of course
1340 the message never leaves the cluster.  This can be rectified by the sysop
1341 by using the <em>msg</em> command.
1342
1343 <P>Bulletin addresses can be set using the Forward.pl file.
1344
1345 <sect1>Forward.pl
1346
1347 <P>
1348 DXSpider receives all and any mail sent to it without any alterations needed
1349 in files.  Because personal and bulletin mail are treated differently, there
1350 is no need for a list of accepted bulletin addresses.  It is necessary, however,
1351 to tell the program which links accept which bulletins.  For example, it is
1352 pointless sending bulletins addresses to "UK" to any links other than UK
1353 ones.  The file that does this is called forward.pl and lives in /spider/msg.
1354 At default, like other spider files it is named forward.pl.issue.  Rename it
1355 to forward.pl and edit the file to match your requirements.
1356 The format is below ...
1357
1358 <tscreen><verb>
1359 #
1360 # this is an example message forwarding file for the system
1361 #
1362 # The format of each line is as follows
1363 #
1364 #     type    to/from/at pattern action  destinations
1365 #     P/B/F     T/F/A     regex   I/F    [ call [, call ...] ]
1366 #
1367 # type: P - private, B - bulletin (msg), F - file (ak1a bull)
1368 # to/from/at: T - to field, F - from field, A - home bbs, O - origin 
1369 # pattern: a perl regex on the field requested
1370 # action: I - ignore, F - forward
1371 # destinations: a reference to an array containing node callsigns
1372 #
1373 # if it is non-private and isn't in here then it won't get forwarded 
1374 #
1375 # Currently only type B msgs are affected by this code.
1376
1377 # The list is read from the top down, the first pattern that matches
1378 # causes the action to be taken.
1379 #
1380 # The pattern can be undef or 0 in which case it will always be selected
1381 # for the action specified
1382 #
1383 # If the BBS list is undef or 0 and the action is 'F' (and it matches the
1384 # pattern) then it will always be forwarded to every node that doesn't have 
1385 # it (I strongly recommend you don't use this unless you REALLY mean it, if
1386 # you allow a new link with this on EVERY bull will be forwarded immediately
1387 # on first connection)
1388 #
1389
1390 package DXMsg;
1391
1392 @forward = (
1393 'B',    'T',    'LOCAL',        'F',    [ qw(GB7MBC) ],
1394 'B',    'T',    'ALL',          'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
1395 'B',    'T',    'UK',           'F',    [ qw(GB7BAA GB7ADX) ],
1396 'B',    'T',    'QSL',          'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
1397 'B',    'T',    'QSLINF',       'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
1398 'B',    'T',    'DX',           'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
1399 'B',    'T',    'DXINFO',       'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
1400 'B',    'T',    'DXNEWS',       'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
1401 'B',    'T',    'DXQSL',        'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
1402 'B',    'T',    'SYSOP',        'F',    [ qw(GB7BAA GB7ADX) ],
1403 'B',    'T',    '50MHZ',        'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
1404 );
1405 </verb></tscreen>
1406
1407 Simply insert a bulletin address and state in the brackets where you wish
1408 that mail to go.  For example, you can see here that mail sent to "UK" will
1409 only be sent to the UK links and not to PA4AB-14.
1410
1411 <P>
1412 To force the cluster to reread the file use load/forward
1413
1414
1415 <sect1>The msg command
1416
1417 <P>
1418 The <em>msg</em> command is a very powerful and flexible tool for the
1419 sysop.  It allows the sysop to alter to and from fields and make other
1420 changes to manage the cluster mail.
1421
1422 Here is a full list of the various options ...
1423
1424 <tscreen><verb>
1425   MSG TO <msgno> <call>     - change TO callsign to <call>
1426   MSG FRom <msgno> <call>   - change FROM callsign to <call>
1427   MSG PRrivate <msgno>      - set private flag
1428   MSG NOPRrivate <msgno>    - unset private flag
1429   MSG RR <msgno>            - set RR flag
1430   MSG NORR <msgno>          - unset RR flag
1431   MSG KEep <msgno>          - set the keep flag (message won't be deleted ever)
1432   MSG NOKEep <msgno>        - unset the keep flag
1433   MSG SUbject <msgno> <new> - change the subject to <new>
1434   MSG WAittime <msgno>      - remove any waiting time for this message
1435   MSG NOREad <msgno>        - mark message as unread
1436   MSG REad <msgno>          - mark message as read
1437   MSG QUeue                 - queue any outstanding bulletins
1438   MSG QUeue 1               - queue any outstanding private messages
1439 </verb></tscreen>
1440
1441 These commands are simply typed from within the cluster as the sysop user.
1442
1443 <sect1>Message status
1444
1445 <P>
1446 You can check on a message from within the cluster by using the command
1447 <em>stat/msg</em>.  This will give you additional information on the
1448 message number including which nodes have received it, which node it
1449 was received from and when etc.  Here is an example of the output of
1450 the command ...
1451
1452 <tscreen><verb>
1453 G0VGS de GB7MBC 28-Jan-2001 1308Z >
1454 stat/msg 6869
1455         From: GB7DJK
1456     Msg Time: 26-Jan-2001 1302Z
1457        Msgno: 6869
1458       Origin: GB7DJK
1459         Size: 8012
1460      Subject: AMSAT 2line KEPS 01025.AMSAT
1461           To: UK
1462 Got it Nodes: GB7BAA, GB7ADX
1463      Private: 0
1464 Read Confirm: 0
1465   Times read: 0
1466 G0VGS de GB7MBC 28-Jan-2001 1308Z >
1467 </verb></tscreen>
1468
1469 <sect1>Filtering mail
1470
1471 <P>
1472 This is described in the section on <em>Other filters</em> so I will not
1473 duplicate it here.
1474
1475 <sect1>Distribution lists
1476
1477 <P>
1478 Distribution lists are simply a list of users to send certain types of
1479 mail to.  An example of this is mail you only wish to send to other
1480 sysops.  In /spider/msg there is a directory called <em>distro</em>.  You
1481 put any distibution lists in here.  For example, here is a file called
1482 SYSOP.pl that caters for the UK sysops.
1483
1484 <tscreen><verb>
1485 qw(GB7TLH GB7DJK GB7DXM GB7CDX GB7BPQ GB7DXN GB7MBC GB7MBC-6 GB7MDX
1486    GB7NDX GB7SDX GB7TDX GB7UDX GB7YDX GB7ADX GB7BAA GB7DXA GB7DXH 
1487    GB7DXK GB7DXI GB7DXS)
1488 </verb></tscreen>
1489
1490 Any mail sent to "sysop" would only be sent to the callsigns in this list.
1491
1492 <sect1>BBS interface
1493
1494 <P>
1495 Spider provides a simple BBS interface.  No input is required from the sysop
1496 of the cluster at all.  The BBS simply sets the cluster as a BBS and pushes
1497 any required mail to the cluster.  No mail can flow from Spider to the BBS,
1498 the interface is one-way.
1499
1500 <P>
1501 Please be careful not to flood the cluster network with unnecessary mail.
1502 Make sure you only send mail to the clusters that want it by using the
1503 Forward.pl file very carefully.
1504
1505 <sect>Information, files and useful programs
1506
1507 <sect1>MOTD
1508
1509 <P>
1510 One of the more important things a cluster sysop needs to do is to get 
1511 information to his users.  The simplest way to do this is to have a banner 
1512 that is sent to the user on login.  This is know as a "message of the day" 
1513 or "motd".  To set this up, simply create a file in /spider/data called motd 
1514 and edit it to say whatever you want.  It is purely a text file and will be 
1515 sent automatically to anyone logging in to the cluster.
1516
1517 <sect1>Downtime message
1518
1519 <P>
1520 If for any reason the cluster is down, maybe for upgrade or maintenance but 
1521 the machine is still running, a message can be sent to the user advising them 
1522 of the fact.  This message lives in the /spider/data directory and is called
1523 "offline".  Simply create the file and edit it to say whatever you wish.  
1524 This file will be sent to a user attempting to log into the cluster when
1525 DXSpider is not actually running.
1526
1527 <sect1>Other text messages
1528
1529 <P>
1530 You can set other text messages to be read by the user if they input the file 
1531 name.  This could be for news items or maybe information for new users.  
1532 To set this up, make a directory under /spider called <em>packclus</em>.  
1533 Under this directory you can create files called <em>news</em> or <em>newuser</em>
1534 for example.  In fact you can create files with any names you like.  These can 
1535 be listed by the user with the command ....
1536
1537 <tscreen><verb>
1538 show/files
1539 </verb></tscreen>
1540
1541 They can be read by the user by typing the command ....
1542
1543 <tscreen><verb>
1544 type news
1545 </verb></tscreen>
1546
1547 If the file they want to read is called <em>news</em>.  You could also set 
1548 an alias for this in the Alias file to allow them just to type <em>news</em>
1549
1550 <P>
1551 You can also store other information in this directory, either directly or 
1552 nested under directories.  One use for this would be to store DX bulletins 
1553 such as the OPDX bulletins.  These can be listed and read by the user.  
1554 To keep things tidy, make a directory under /spider/packclus called
1555 <em>bulletins</em>.  Now copy any OPDX or similar bulletins into it.  These 
1556 can be listed by the user in the same way as above using the <em>show/files</em>
1557 command with an extension for the bulletins directory you have just created, 
1558 like this ....
1559
1560 <tscreen><verb>
1561 show/files bulletins
1562 </verb></tscreen>
1563
1564 <P>
1565 An example would look like this ....
1566
1567 <tscreen><verb>
1568 sh/files
1569 bulletins      DIR 20-Dec-1999 1715Z news          1602 14-Dec-1999 1330Z
1570 </verb></tscreen>
1571
1572 You can see that in the files area (basically the packclus directory) there is a 
1573 file called <em>news</em> and a directory called <em>bulletins</em>.  You can 
1574 also see that dates they were created.  In the case of the file <em>news</em>, 
1575 you can also see the time it was last modified, a good clue as to whether the 
1576 file has been updated since you last read it.  To read the file called 
1577 <em>news</em> you would simply issue the command ....
1578
1579 <tscreen><verb>
1580 type news
1581 </verb></tscreen>
1582
1583 To look what is in the bulletins directory you issue the command ....
1584
1585 <tscreen><verb>
1586 show/files bulletins
1587 opdx390      21381 29-Nov-1999 1621Z opdx390.1     1670 29-Nov-1999 1621Z
1588 opdx390.2     2193 29-Nov-1999 1621Z opdx391      25045 29-Nov-1999 1621Z  
1589 opdx392      35969 29-Nov-1999 1621Z opdx393      15023 29-Nov-1999 1621Z  
1590 opdx394      33429 29-Nov-1999 1621Z opdx394.1     3116 29-Nov-1999 1621Z  
1591 opdx395      24319 29-Nov-1999 1621Z opdx396      32647 29-Nov-1999 1621Z
1592 opdx396.1     5537 29-Nov-1999 1621Z opdx396.2     6242 29-Nov-1999 1621Z
1593 opdx397      18433 29-Nov-1999 1621Z opdx398      19961 29-Nov-1999 1621Z  
1594 opdx399      17719 29-Nov-1999 1621Z opdx400      19600 29-Nov-1999 1621Z
1595 opdx401      27738 29-Nov-1999 1621Z opdx402      18698 29-Nov-1999 1621Z
1596 opdx403      24994 29-Nov-1999 1621Z opdx404      15685 29-Nov-1999 1621Z
1597 opdx405      13984 29-Nov-1999 1621Z opdx405.1     4166 29-Nov-1999 1621Z
1598 opdx406      28934 29-Nov-1999 1621Z opdx407      24153 29-Nov-1999 1621Z
1599 opdx408      15081 29-Nov-1999 1621Z opdx409      23234 29-Nov-1999 1621Z
1600 Press Enter to continue, A to abort (16 lines) >
1601 </verb></tscreen>
1602
1603 You can now read any file in this directory using the type command, like this ....
1604
1605 <tscreen><verb>
1606 type bulletins/opdx391
1607 Ohio/Penn DX Bulletin No. 391
1608 The Ohio/Penn Dx PacketCluster
1609 DX Bulletin No. 391
1610 BID: $OPDX.391
1611 January 11, 1999
1612 Editor Tedd Mirgliotta, KB8NW
1613 Provided by BARF-80 BBS Cleveland, Ohio
1614 Online at 440-237-8208 28.8k-1200 Baud 8/N/1 (New Area Code!)
1615 Thanks to the Northern Ohio Amateur Radio Society, Northern Ohio DX
1616 Association, Ohio/Penn PacketCluster Network, K1XN & Golist, WB2RAJ/WB2YQH
1617 & The 59(9) DXReport, W3UR & The Daily DX, K3TEJ, KN4UG, W4DC, NC6J, N6HR,
1618 Press Enter to continue, A to abort (508 lines) >
1619 </verb></tscreen>
1620
1621 The page length will of course depend on what you have it set to!
1622
1623 <sect1>The Aliases file
1624
1625 <P>
1626 You will find a file in /spider/cmd/ called Aliases.  First, copy this file to
1627 /spider/local_cmd/Aliases and edit this file.  You will see something like this ...
1628
1629 <tscreen><verb>
1630
1631 #!/usr/bin/perl
1632
1633 # provide some standard aliases for commands for terminally
1634 # helpless ak1a user (helpless in the sense that they never
1635 # read nor understand help files)
1636
1637 # This file is automagically reloaded if its modification time is 
1638 # later than the one stored in CmdAlias.pm
1639
1640 # PLEASE make this file consistant with reality! (the patterns MUST
1641 # match the filenames!)
1642
1643 # Don't alter this file, copy it into the local_cmd tree and modify it.
1644 # This file will be replaced everytime I issue a new release.
1645
1646 # You only need to put aliases in here for commands that don't work as
1647 # you desire naturally, e.g sh/dx on its own just works as you expect
1648 # so you need not add it as an alias.
1649
1650
1651
1652 package CmdAlias;
1653
1654 %alias = (
1655     '?' => [
1656           '^\?', 'apropos', 'apropos',
1657         ],
1658     'a' => [
1659           '^ann.*/full', 'announce full', 'announce', 
1660           '^ann.*/sysop', 'announce sysop', 'announce',
1661           '^ann.*/(.*)$', 'announce $1', 'announce',
1662         ],
1663         'b' => [
1664         ],
1665         'c' => [
1666         ],
1667         'd' => [
1668           '^del', 'kill', 'kill',
1669           '^del\w*/fu', 'kill full', 'kill',
1670           '^di\w*/a\w*', 'directory all', 'directory',
1671           '^di\w*/b\w*', 'directory bulletins', 'directory',
1672           '^di\w*/n\w*', 'directory new', 'directory',
1673           '^di\w*/o\w*', 'directory own', 'directory',
1674           '^di\w*/s\w*', 'directory subject', 'directory',
1675           '^di\w*/t\w*', 'directory to', 'directory',
1676           '^di\w*/f\w*', 'directory from', 'directory',
1677           '^di\w*/(\d+)', 'directory $1', 'directory',
1678         ],
1679         'e' => [
1680         ],
1681         'f' => [
1682         ],
1683         'g' => [
1684         ],
1685         'h' => [
1686         ],
1687         'i' => [
1688         ],
1689         'j' => [
1690         ],
1691         'k' => [
1692         ],
1693         'l' => [
1694           '^l$', 'directory', 'directory',
1695           '^ll$', 'directory', 'directory',
1696           '^ll/(\d+)', 'directory $1', 'directory',
1697         ],
1698         'm' => [
1699         ],
1700         'n' => [
1701           '^news', 'type news', 'type',
1702         ],
1703         'o' => [
1704         ],
1705         'p' => [
1706         ],
1707         'q' => [
1708           '^q', 'bye', 'bye',
1709         ],
1710         'r' => [        
1711           '^r$', 'read', 'read',
1712           '^rcmd/(\S+)', 'rcmd $1', 'rcmd',
1713         ],
1714         's' => [
1715           '^s/p$', 'send', 'send',
1716           '^sb$', 'send noprivate', 'send',
1717           '^set/home$', 'set/homenode', 'set/homenode',
1718           '^set/nobe', 'unset/beep', 'unset/beep',
1719           '^set/nohe', 'unset/here', 'unset/here',
1720           '^set/noan', 'unset/announce', 'unset/announce',
1721           '^set/nodx', 'unset/dx', 'unset/dx',
1722           '^set/nota', 'unset/talk', 'unset/talk',
1723           '^set/noww', 'unset/wwv', 'unset/wwv',
1724           '^set/nowx', 'unset/wx', 'unset/wx',
1725           '^sh$', 'show', 'show',
1726           '^sh\w*/buck', 'dbshow buck', 'dbshow',
1727           '^sh\w*/bu', 'show/files bulletins', 'show/files',
1728           '^sh\w*/c/n', 'show/configuration nodes', 'show/configuration',
1729           '^sh\w*/c$', 'show/configuration', 'show/configuration',
1730           '^sh\w*/com', 'dbavail', 'dbavail',
1731           '^sh\w*/dx/(\d+)-(\d+)', 'show/dx $1-$2', 'show/dx',
1732           '^sh\w*/dx/(\d+)', 'show/dx $1', 'show/dx',
1733           '^sh\w*/dx/d(\d+)', 'show/dx from $1', 'show/dx',
1734           '^sh\w*/email', 'dbshow email', 'dbshow',
1735           '^sh\w*/hftest', 'dbshow hftest', 'dbshow',
1736           '^sh\w*/vhftest', 'dbshow vhftest', 'dbshow',
1737           '^sh\w*/qsl', 'dbshow qsl', 'dbshow',
1738           '^sh\w*/tnc', 'who', 'who',
1739           '^sh\w*/up', 'show/cluster', 'show/cluster',
1740           '^sh\w*/w\w*/(\d+)-(\d+)', 'show/wwv $1-$2', 'show/wwv',
1741           '^sh\w*/w\w*/(\d+)', 'show/wwv $1', 'show/wwv',
1742           '^sp$', 'send', 'send',
1743         
1744     ],
1745         't' => [
1746           '^ta$', 'talk', 'talk',
1747           '^t$', 'talk', 'talk',
1748         ],
1749         'u' => [
1750         ],
1751         'v' => [
1752         ],
1753         'w' => [
1754           '^wx/full', 'wx full', 'wx',
1755           '^wx/sysop', 'wx sysop', 'wx',
1756         ],
1757         'x' => [
1758         ],
1759         'y' => [
1760         ],
1761         'z' => [
1762         ],
1763 )
1764 </verb></tscreen>
1765
1766 You can create aliases for commands at will.  Beware though, these may not 
1767 always turn out as you think.  Care is needed and you need to test the 
1768 results once you have set an alias.
1769
1770 <sect1>Console.pl
1771
1772 <P>
1773 In later versions of Spider a simple console program is provided for the sysop.  
1774 This has a type ahead buffer with line editing facilities and colour for spots,
1775 announces etc.  To use this program, simply use console.pl instead of client.pl.
1776
1777 <P>
1778 To edit the colours, copy /spider/perl/Console.pl to /spider/local and edit the 
1779 file with your favourite editor.
1780
1781 <sect1>Updating kepler data
1782
1783 <P>
1784 Spider has a powerful and flexible show/satellite command.  In order for
1785 this to be accurate, the kepler data has to be updated regularly.  In
1786 general, this data is available as an email or via cluster mail.
1787 Updating it is simple.  First you need to export the mail message as a
1788 file.  You do this with the <em>export</em> command from the cluster prompt
1789 as the sysop.  For example ...
1790
1791 <tscreen><verb>
1792 export 5467 /spider/perl/keps.in
1793 </verb></tscreen>
1794
1795 would export message number 5467 as a file called keps.in in the
1796 /spider/perl directory.
1797
1798 Now login to a VT as sysop and cd /spider/perl.  There is a command in
1799 the perl directory called <em>convkeps.pl</em>.  All we need to do now is
1800 convert the file like so ...
1801
1802 <tscreen><verb>
1803 ./convkeps.pl keps.in
1804 </verb></tscreen>
1805
1806 Now go back to the cluster and issue the command ...
1807
1808 <tscreen><verb>
1809 load/keps
1810 </verb></tscreen>
1811
1812 That is it!  the kepler data has been updated.
1813
1814
1815 <sect>CVS
1816
1817 <P>
1818 CVS stands for "Concurrent Versions System" and the CVS for DXSpider is held
1819 at <htmlurl url="http://www.sourceforge.net" name="Sourceforge">.  This means
1820 that it is possible to update your DXSpider installation to the latest
1821 sources by using a few simple commands.
1822
1823 <P>
1824 THIS IS NOT FOR THE FAINT HEARTED!!!  ONLY DO THIS IF YOU HAVE A TEST
1825 INSTALLATION OR ARE WILLING TO HAVE YOUR CLUSTER CRASH ON YOU!!!
1826 THIS MUST BE CONSIDERED AT LEAST BETA TESTING AND MAYBE EVEN ALPHA!!
1827 YOU HAVE BEEN WARNED!!!
1828
1829 <P>
1830 DID I MENTION..... ONLY DO THIS IF YOU ARE WILLING TO ACCEPT THE
1831 CONSEQUENCES!!!
1832
1833 <P>
1834 I am of course assuming that you have a machine with both DXSpider and
1835 Internet access running.
1836
1837 <P>
1838 BEFORE YOU EVEN CONSIDER STARTING WITH THIS MAKE A BACKUP OF YOUR
1839 ENTIRE SPIDER TREE!!
1840
1841 <P>
1842 Assuming you are connected to the Internet, you need to login to the
1843 CVS repository and then update your Spider source.  There are several
1844 steps which are listed below ...
1845
1846 <P>
1847 First login as the user <em>sysop</em>.  Next you need to connect to the CVS
1848 repository.  You do this with the command below ...
1849
1850 <verb>
1851 cvs -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login 
1852 </verb>
1853
1854 You will get a password prompt.  Simply hit return here and your machine should
1855 return to a normal linux prompt.
1856
1857 <P>
1858 What happens next depends on whether you have an existing installation that 
1859 you want to update with the latest and greatest or whether you just want
1860 to see what is there and/or run it on a new machine for testing.
1861 Either way you will want to change directory to a new place, if you want to
1862 update an existing installation then I suggest /tmp, otherwise choose a
1863 suitable place according to the normal installation instructions.
1864
1865 <P>
1866 The next step will create a brand new 'spider' directory in your current
1867 directory.
1868
1869 <verb>
1870 cvs -z3 -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider co spider
1871 </verb>
1872
1873 This command is all on one line.
1874
1875 <P>
1876 Hopefully your screen should show you downloading files.  The -z3 simply compresses
1877 the download to improve speed.
1878 When this has finished, you will have exactly the same as if you had untarred a full 
1879 tarball PLUS some extra directories and files that CVS needs to do the magic that 
1880 it does.
1881
1882 <P>
1883 Now if you are doing a new installation, that's it.  Carry on as if you have
1884 just downloaded and untarred the lastest tarball.
1885
1886 <P>
1887 If you want to upgrade your current installation then do this ...
1888
1889 <tscreen><verb>
1890 tar cvfz /tmp/s.tgz spider
1891 cd /
1892 tar xvfzp /tmp/s.tgz
1893 </verb></tscreen>
1894
1895 This is assuming you downloaded to the /tmp directory of course.
1896
1897 <P>
1898 NOTE:  the 'p' on the end of the 'xvfz' is IMPORTANT!   It keeps the permissions
1899 correct.  YOU WERE LOGGED IN AS THE USER SYSOP WEREN'T YOU?????
1900
1901 Remember to recompile the C client (cd /spider/src; make)
1902
1903 <P>
1904 At this point the files have been upgraded.  You can (usually) restrt the cluster
1905 in your own time.  However, if you attempt to use any new commands or features
1906 expect it to be fatal!  At least your cluster will have been restarted then so it
1907 will be too late to worry about it!
1908
1909 <P>
1910 Now the magic part!  From now on when you want to update, simply connect to the 
1911 Internet and then, as the user <em>sysop</em> ...
1912
1913 <tscreen><verb>
1914 cd /spider
1915 cvs -z3 update -d
1916 </verb></tscreen>
1917
1918 and your files will be updated.  As above, remember to recompile the "C" client 
1919 if it has been updated (CVS will tell you) and restart if any of the perl scripts
1920 have been altered or added, again, CVS will tell you.
1921
1922 <P>
1923 You will find any changes documented in the /spider/Changes file.
1924
1925 <sect>The DXSpider command set
1926
1927 <P>
1928 Below is a complete list of commands available from the cluster prompt.
1929 Most maintenance tasks are automatic but there are some commands that are useful 
1930 for a sysop.  These are listed below in alphabetical order.  The number in 
1931 brackets following the command name is the permissions level needed to use 
1932 the command.
1933
1934 <sect1>accept/announce (0)
1935
1936 <P>
1937 <tt>
1938 <bf>accept/announce &lsqb;0-9&rsqb; &lt;pattern&gt;</bf> Set an accept filter
1939  line for announce
1940 </tt>
1941
1942 <P>
1943 Create an 'accept this announce' line for a filter. 
1944
1945 An accept filter line means that if the announce matches this filter it is
1946 passed onto the user. See HELP FILTERS for more info. Please read this
1947 to understand how filters work - it will save a lot of grief later on.
1948
1949 You can use any of the following things in this line:-
1950
1951 <tscreen><verb>
1952   info <string>            eg: iota or qsl
1953   by <prefixes>            eg: G,M,2         
1954   origin <prefixes>
1955   origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
1956   origin_itu <numbers>
1957   origin_zone <numbers>
1958   by_dxcc <numbers>
1959   by_itu <numbers>
1960   by_zone <numbers>
1961   channel <prefixes>
1962   wx 1                     filter WX announces
1963   dest <prefixes>          eg: 6MUK,WDX      (distros)
1964 </verb></tscreen>
1965
1966 some examples:-
1967
1968 <tscreen><verb>
1969   acc/ann dest 6MUK
1970   acc/ann 2 by_zone 14,15,16
1971   (this could be all on one line: acc/ann dest 6MUK or by_zone 14,15,16)
1972 </verb></tscreen>
1973
1974 or
1975
1976 <tscreen><verb>
1977   acc/ann by G,M,2 
1978 </verb></tscreen>
1979
1980 This filter would only allow announces that were posted buy UK stations.  
1981 You can use the tag 'all' to accept everything eg:
1982
1983 <tscreen><verb>
1984   acc/ann all
1985 </verb></tscreen>
1986
1987 but this probably for advanced users...
1988
1989 <sect1>accept/announce (extended for sysops) (8)
1990
1991 <P>
1992 <tt>
1993 <bf>accept/announce &lt;call&gt; &lsqb;input&rsqb; &lsqb;0-9&rsqb;&lt;pattern&gt;</bf> Announce filter sysop version
1994 </tt>
1995
1996 <P>
1997 This version allows a sysop to set a filter for a callsign as well as the
1998 default for nodes and users eg:-
1999
2000 <tscreen><verb>
2001   accept/ann by G,M,2
2002   accept/ann input node_default by G,M,2
2003   accept/ann user_default by G,M,2
2004 </verb></tscreen>
2005
2006 <sect1>accept/spots (0)
2007
2008 <P>
2009 <tt>
2010 <bf>accept/announce &lsqb;0-9&rsqb; &lt;pattern&gt;</bf> Set an accept filter 
2011 line for spots
2012 </tt>
2013
2014 <P>
2015 Create an 'accept this spot' line for a filter.
2016
2017 <P>
2018 An accept filter line means that if the spot matches this filter it is
2019 passed onto the user. See HELP FILTERS for more info. Please read this
2020 to understand how filters work - it will save a lot of grief later on.
2021
2022 You can use any of the following things in this line:-
2023
2024 <tscreen><verb>
2025   freq <range>           eg: 0/30000 or hf or hf/cw or 6m,4m,2m
2026   on <range>             same as 'freq'
2027   call <prefixes>        eg: G,PA,HB9
2028   info <string>          eg: iota or qsl
2029   by <prefixes>            
2030   call_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
2031   call_itu <numbers>
2032   call_zone <numbers>
2033   by_dxcc <numbers>
2034   by_itu <numbers>
2035   by_zone <numbers>
2036   origin <prefixes>
2037   channel <prefixes>
2038 </verb></tscreen>
2039
2040 <P>
2041 For frequencies, you can use any of the band names defined in
2042 SHOW/BANDS and you can use a subband name like: cw, rtty, data, ssb -
2043 thus: hf/ssb. You can also just have a simple range like: 0/30000 -
2044 this is more efficient than saying simply: freq HF (but don't get
2045 too hung up about that)
2046
2047 some examples:-
2048
2049 <tscreen><verb>
2050   acc/spot 1 on hf/cw
2051   acc/spot 2 on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
2052 </verb></tscreen>
2053
2054 You can use the tag 'all' to accept everything, eg:
2055
2056 <tscreen><verb>
2057   acc/spot 3 all
2058 </verb></tscreen>
2059
2060 but this probably for advanced users...
2061
2062 <sect1>accept/spots (extended for sysops) (8)
2063
2064 <P>
2065 <tt>
2066 <bf>accept/spots &lt;call&gt; &lsqb;input&rsqb; &lsqb;0-9&rsqb; &lt;pattern&gt;</bf> Spot filter sysop version
2067 </tt>
2068
2069 <P>
2070 This version allows a sysop to set a filter for a callsign as well as the
2071 default for nodes and users eg:-
2072
2073 <tscreen><verb>
2074   accept/spot db0sue-7 1 by_zone 14,15,16
2075   accept/spot node_default all
2076   set/hops node_default 10
2077
2078   accept/spot user_default by G,M,2
2079 </verb></tscreen>
2080
2081 <sect1>accept/wcy (0)
2082
2083 <P>
2084 <tt>
2085 <bf>accept/wcy &lsqb;0-9&rsqb; &lt;pattern&gt;</bf> set an accept WCY filter
2086 </tt>
2087
2088 <P>
2089 It is unlikely that you will want to do this, but if you do then you can
2090 filter on the following fields:-
2091
2092 <tscreen><verb>
2093   by <prefixes>            eg: G,M,2         
2094   origin <prefixes>
2095   origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
2096   origin_itu <numbers>
2097   origin_zone <numbers>
2098   by_dxcc <numbers>
2099   by_itu <numbers>
2100   by_zone <numbers>
2101   channel <prefixes>
2102 </verb></tscreen>
2103
2104 <P>
2105 There are no examples because WCY Broadcasts only come from one place and
2106 you either want them or not (see UNSET/WCY if you don't want them).
2107
2108 This command is really provided for future use.
2109
2110 See HELP FILTER for information.
2111
2112 <sect1>accept/wcy (extended for sysops) (8)
2113
2114 <P>
2115 <tt>
2116 <bf>accept/wcy &lt;call&gt; &lsqb;input&rsqb; &lsqb;0-9&rsqb; &lt;pattern&gt;</bf>
2117 WCY filter sysop version
2118 </tt>
2119
2120 <P>
2121 This version allows a sysop to set a filter for a callsign as well as the
2122 default for nodes and users eg:-
2123
2124 <tscreen><verb>
2125   accept/wcy node_default all
2126   set/hops node_default 10
2127 </verb></tscreen>
2128
2129 <sect1>accept/wwv (0)
2130
2131 <P>
2132 <tt>
2133 <bf>accept/wwv &lsqb;0-9&rsqb; &lt;pattern&gt;</bf> Set an accept WWV filter
2134 </tt>
2135
2136 <P>
2137 It is unlikely that you will want to do this, but if you do then you can
2138 filter on the following fields:-
2139
2140 <tscreen><verb>
2141   by <prefixes>            eg: G,M,2         
2142   origin <prefixes>
2143   origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
2144   origin_itu <numbers>
2145   origin_zone <numbers>
2146   by_dxcc <numbers>
2147   by_itu <numbers>
2148   by_zone <numbers>
2149   channel <prefixes>
2150 </verb></tscreen>
2151
2152 for example 
2153
2154 <tscreen><verb>
2155   accept/wwv by_zone 4
2156 </verb></tscreen>
2157
2158 is probably the only useful thing to do (which will only show WWV broadcasts
2159 by stations in the US).
2160
2161 See HELP FILTER for information.
2162
2163 <sect1>accept/wwv (extended for sysops) (8)
2164
2165 <P>
2166 <tt>
2167 <bf>accept/wwv &lt;call&gt; &lsqb;input&rsqb; &lsqb;0-9&rsqb; &lt;pattern&gt;</bf>
2168 WWV filter sysop version
2169 </tt>
2170
2171 <P>
2172 This version allows a sysop to set a filter for a callsign as well as the
2173 default for nodes and users eg:-
2174
2175 <tscreen><verb>
2176   accept/wwv db0sue-7 1 by_zone 4
2177   accept/wwv node_default all
2178   set/hops node_default 10
2179
2180   accept/wwv user_default by W,K
2181 </verb></tscreen>
2182
2183 <sect1>announce (0)
2184
2185 <P>
2186 <tt>
2187 <bf>announce &lt;text&gt;</bf> Send an announcement to local users
2188 </tt>
2189
2190 <P>
2191 Send an announcement to LOCAL users only, where &lt;text&gt; is the text 
2192 of the announcement you wish to broadcast
2193
2194 <sect1>announce full (0)
2195
2196 <P>
2197 <tt>
2198 <bf>announce full &lt;text&gt;</bf> Send an announcement cluster wide
2199 </tt>
2200
2201 <P>
2202 This command will send your announcement across the whole cluster
2203 network.
2204
2205
2206 <sect1>announce sysop (5)
2207
2208 <P>
2209 <tt>
2210 <bf>announce sysop &lt;text&gt;</bf>
2211 </tt>
2212
2213 <P>
2214 Send an announcement to Sysops only
2215
2216 <sect1>apropos (0)
2217
2218 <P>
2219 <tt>
2220 <bf>apropos &lt;string&gt;</bf> Search the help database
2221 </tt>
2222
2223 <P>
2224 Search the help database for &lt;string&gt; (it isn't case sensitive), 
2225 and print the names of all the commands that may be relevant.
2226
2227 <sect1>bye (0)
2228
2229 <P>
2230 <tt>
2231 <bf>bye</bf> Exit from the cluster
2232 </tt>
2233
2234 <P>
2235 This will disconnect you from the cluster
2236
2237 <sect1>catchup (5)
2238
2239 <P>
2240 <tt>
2241 <bf>catchup &lt;node_call&gt; All&verbar;&lsqb;&lt;msgno&gt; ...&rsqb;</bf> 
2242 Mark a message as sent
2243 </tt>
2244
2245 <P>
2246 When you send messages the fact that you have forwarded it to another node 
2247 is remembered so that it isn't sent again. When you have a new partner
2248 node and you add their callsign to your /spider/msg/forward.pl file, all
2249 outstanding non-private messages will be forwarded to them. This may well
2250 be ALL the non-private messages. You can prevent this by using these 
2251 commmands:-
2252
2253 <tscreen><verb>
2254   catchup GB7DJK all
2255   catchup GB7DJK 300 301 302 303 500-510
2256 </verb></tscreen>
2257         
2258 and to undo what you have just done:-
2259   
2260 <tscreen><verb>
2261   uncatchup GB7DJK all
2262   uncatchup GB7DJK 300 301 302 303 500-510
2263 </verb></tscreen>
2264
2265 which will arrange for them to be forward candidates again.
2266
2267 Order is not important.
2268
2269 <sect1>clear/spots (0)
2270
2271 <P>
2272 <tt>
2273 <bf>clear/spots &lsqb;1&verbar;all&rsqb;</bf> Clear a spot filter line
2274 </tt>
2275
2276 <P>
2277 This command allows you to clear (remove) a line in a spot filter or to 
2278 remove the whole filter.
2279
2280 If you have a filter:-
2281
2282 <tscreen><verb>
2283   acc/spot 1 on hf/cw
2284   acc/spot 2 on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
2285 </verb></tscreen>
2286
2287 and you say:-
2288
2289 <tscreen><verb>
2290   clear/spot 1
2291 </verb></tscreen>
2292
2293 you will be left with:-
2294
2295 <tscreen><verb>
2296   acc/spot 2 on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
2297 </verb></tscreen>
2298
2299 If you do:
2300
2301 <tscreen><verb>
2302   clear/spot all
2303 </verb></tscreen>
2304
2305 the filter will be completely removed.
2306
2307
2308 <sect1>connect (5) 
2309
2310 <P>
2311 <tt>
2312 <bf>connect &lt;callsign&gt;</bf> Start a connection to another DX Cluster
2313 </tt>
2314
2315 <P>
2316 Start a connection process that will culminate in a new connection to the
2317 DX cluster &lt;callsign&gt;. This process creates a new 'client' process which will
2318 use the script in /spider/connect/&lt;callsign&gt; to effect the 'chat' exchange
2319 necessary to traverse the network(s) to logon to the cluster &lt;callsign&gt;.
2320
2321 <sect1>dbavail (0)
2322
2323 <P>
2324 <tt>
2325 <bf>dbavail</bf> Show a list of all the databases in the system
2326 </tt>
2327
2328 <P>
2329 The title says it all really, this command lists all the databases defined
2330 in the system. It is also aliased to SHOW/COMMAND.
2331
2332 <sect1>dbcreate (9)
2333
2334 <P>
2335 <tt>
2336 <bf>dbcreate &lt;name&gt;</bf> Create a database entry<newline>
2337 <bf>dbcreate &lt;name&gt; chain &lt;name&gt; [&lt;name&gt;..]</bf> Create a 
2338 chained database entry<newline>
2339 <bf>dbcreate &lt;name&gt; remote &lt;node&gt;</bf> Create a remote database
2340 entry<newline>
2341 </tt>
2342
2343 <P>
2344 DBCREATE allows you to define a database in the system. It doesn't actually
2345 create anything, just defines it.
2346
2347 The databases that are created are simple DB_File hash databases, they are 
2348 therefore already 'indexed'.
2349
2350 You can define a local database with the first form of the command eg:
2351
2352   DBCREATE oblast
2353
2354 You can also chain databases with the addition of the 'chain' keyword. 
2355 This will search each database one after the other. A typical example 
2356 is:
2357
2358   DBCREATE sdx_qsl chain sql_ad
2359
2360 No checking is done to see if the any of the chained databases exist, in
2361 fact it is usually better to do the above statement first then do each of
2362 the chained databases.
2363
2364 Databases can exist offsite. To define a database that lives on another 
2365 node do:
2366
2367   DBCREATE buckmaster remote gb7dxc
2368
2369 Remote databases cannot be chained; however, the last database in a 
2370 a chain can be a remote database eg:
2371
2372   DBCREATE qsl chain gb7dxc
2373
2374 To see what databases have been defined do:
2375
2376   DBAVAIL (or it will have been aliased to SHOW/COMMAND)
2377
2378 It would be normal for you to add an entry into your local Aliases file
2379 to allow people to use the 'SHOW/&lt;dbname&gt;' style syntax. So you would
2380 need to add a line like:-
2381
2382 <tscreen><verb>
2383   's' => [
2384     ..
2385     ..
2386     '^sh\w*/buc', 'dbshow buckmaster', 'dbshow',
2387     ..
2388     ..
2389    ],
2390 </verb></tscreen>
2391
2392 to allow 
2393
2394   SH/BUCK g1tlh
2395
2396 to work as they may be used to.
2397
2398 See DBIMPORT for the importing of existing AK1A format data to databases.
2399 See DBSHOW for generic database enquiry
2400
2401 <sect1>dbimport (9)
2402
2403 <P>
2404 <tt>
2405 <bf>dbimport &lt;dbname&gt;</bf> Import AK1A data into a database
2406 </tt>
2407
2408 <P>
2409 If you want to import or update data in bulk to a database you can use
2410 this command. It will either create or update entries into an existing
2411 database. For example:-
2412
2413   DBIMPORT oblast /tmp/OBLAST.FUL
2414
2415 will import the standard OBLAST database that comes with AK1A into the
2416 oblast database held locally.
2417
2418 <sect1>dbremove (9)
2419
2420 <P>
2421 <tt>
2422 <bf>dbremove &lt;dbname&gt;</bf> Delete a database
2423 </tt>
2424
2425 <P>
2426 DBREMOVE will completely remove a database entry and also delete any data
2427 file that is associated with it. 
2428
2429 There is no warning, no comeback, no safety net. 
2430
2431 For example:
2432
2433   DBREMOVE oblast 
2434
2435 will remove the oblast database from the system and it will also remove
2436 the associated datafile.
2437
2438 I repeat:
2439
2440 There is no warning, no comeback, no safety net.
2441
2442 You have been warned.
2443
2444 <sect1>dbshow (0)
2445
2446 <P>
2447 <tt>
2448 <bf>dbshow &lt;dbname&gt; &lt;key&gt;</bf> Display an entry, if it exists, 
2449 in a database
2450 </tt>
2451
2452 <P>
2453 This is the generic user interface to the database to the database system.
2454 It is expected that the sysop will add an entry to the local Aliases file
2455 so that users can use the more familiar AK1A style of enquiry such as:
2456
2457 <tscreen><verb>
2458   SH/BUCK G1TLH
2459 </verb></tscreen>
2460
2461 but if he hasn't and the database really does exist (use DBAVAIL or
2462 SHOW/COMMAND to find out) you can do the same thing with:
2463
2464 <tscreen><verb>
2465   DBSHOW buck G1TLH
2466 </verb></tscreen>
2467
2468
2469 <sect1>debug (9)
2470
2471 <P>
2472 <tt>
2473 <bf>debug</bf> Set the cluster program into debug mode
2474 </tt>
2475
2476 <P>
2477 Executing this command will only have an effect if you are running the cluster
2478 in debug mode i.e.
2479
2480 <tscreen><verb>
2481         perl -d cluster.pl
2482 </verb></tscreen>
2483
2484 It will interrupt the cluster just after the debug command has finished.
2485
2486 <sect1>directory (0)
2487
2488 <P>
2489 <tt>
2490 <bf>directory</bf> List messages<newline> 
2491 <bf>directory all</bf> List all messages<newline>
2492 <bf>directory own</bf> List your own messages<newline>
2493 <bf>directory new</bf> List all new messages<newline>
2494 <bf>directory to &lt;call&gt;</bf> List all messages to &lt;call&gt;<newline>
2495 <bf>directory from &lt;call&gt;</bf> List all messages from &lt;call&gt;<newline>
2496 <bf>directory subject &lt;string&gt;</bf> List all messages with &lt;string&gt; 
2497 in subject<newline>
2498 <bf>directory &lt;nn&gt;</bf> List last &lt;nn&gt; messages<newline>
2499 <bf>directory &lt;from&gt;-&lt;to&gt;</bf> List messages &lt;from&gt; message &lt;to&gt; message <newline>
2500 </tt>
2501
2502 <P>
2503 List the messages in the messages directory.
2504
2505 If there is a 'p' one space after the message number then it is a 
2506 personal message. If there is a '-' between the message number and the
2507 'p' then this indicates that the message has been read.
2508
2509 You can use shell escape characters such as '*' and '?' in the &lt;call&gt;
2510 fields.
2511
2512 You can combine some of the various directory commands together eg:-
2513
2514 <tscreen><verb>
2515    DIR TO G1TLH 5
2516 or 
2517    DIR SUBJECT IOTA 200-250
2518 </verb></tscreen>
2519
2520 You can abbreviate all the commands to one letter and use ak1a syntax:-
2521
2522 <tscreen><verb>
2523    DIR/T G1* 10
2524    DIR/S QSL 10-100 5
2525 </verb></tscreen>
2526
2527
2528 <sect1>directory (extended for sysops) (5)
2529
2530 <P>
2531 Works just like the user command except that sysops can see ALL messages.
2532
2533 <sect1>disconnect (8)
2534
2535 <P>
2536 <tt>
2537 <bf>disconnect &lt;call&gt; [&lt;call&gt; ...]</bf> Disconnect a user or node
2538 </tt>
2539
2540 <P>
2541 Disconnect any &lt;call&gt; connected locally
2542
2543 <sect1>dx (0)
2544
2545 <P>
2546 <tt>
2547 <bf>dx &lsqb;by &lt;call&gt;&rsqb; &lt;freq&gt; &lt;call&gt; &lt;remarks&gt;</bf> Send a DX spot
2548 </tt>
2549
2550 <P>
2551 This is how you send a DX Spot to other users. You can, in fact, now
2552 enter the &lt;freq&gt; and the &lt;call&gt; either way round. 
2553
2554 <tscreen><verb>
2555    DX FR0G 144.600
2556    DX 144.600 FR0G
2557    DX 144600 FR0G 
2558 </verb></tscreen>
2559
2560 will all give the same result. You can add some remarks to the end
2561 of the command and they will be added to the spot.
2562
2563 <tscreen><verb>
2564    DX FR0G 144600 this is a test
2565 </verb></tscreen>
2566
2567 You can credit someone else by saying:-
2568
2569 <tscreen><verb>
2570    DX by G1TLH FR0G 144.600 he isn't on the cluster
2571 </verb></tscreen>
2572
2573 The &lt;freq&gt; is compared against the available bands set up in the 
2574 cluster.  See SHOW/BANDS for more information.
2575
2576 <sect1>export (9)
2577
2578 <P>
2579 <tt>
2580 <bf>export &lt;msgno&gt; &lt;filename&gt;</bf> Export a message to a file
2581 </tt>
2582
2583 <P>
2584 Export a message to a file. This command can only be executed on a local
2585 console with a fully privileged user. The file produced will be in a form
2586 ready to be imported back into the cluster by placing it in the import 
2587 directory (/spider/msg/import).
2588
2589 This command cannot overwrite an existing file. This is to provide some 
2590 measure of security. Any files written will owned by the same user as the 
2591 main cluster, otherwise you can put the new files anywhere the cluster can
2592 access. For example:-
2593
2594   EXPORT 2345 /tmp/a
2595
2596 <sect1>export_users (9)
2597
2598 <P>
2599 <tt>
2600 <bf>export_users &lsqb;&lt;filename&gt;&rsqb;</bf> Export the users database to ascii
2601 </tt>
2602
2603 <P>
2604 Export the users database to a file in ascii format. If no filename
2605 is given then it will export the file to /spider/data/user_asc.
2606
2607 If the file already exists it will be renamed to &lt;filename&gt;.o. In fact
2608 up to 5 generations of the file can be kept each one with an extra 'o' on the
2609 suffix. 
2610
2611 BE WARNED: this will write to any file you have write access to. No check is
2612 made on the filename (if any) that you specify.
2613
2614 <sect1>forward/latlong (8)
2615
2616 <P>
2617 <tt>
2618 <bf>forward/latlong &lt;node_call&gt;</bf> Send latitude and longitude 
2619 information to another cluster
2620 </tt>
2621
2622 <P>
2623 This command sends all the latitude and longitude information that your
2624 cluster is holding against callsigns.  One advantage of recieving this
2625 information is that more locator information is held by you.  This
2626 means that more locators are given on the DX line assuming you have
2627 <em>set/dxgrid</em> enabled.  This could be a LOT of information though, so
2628 it is not recommended on slow links.
2629
2630 <sect1>forward/opername (1)
2631
2632 <P>
2633 <tt>
2634 <bf>forward/opername &lt;call&gt;</bf> Send out information on this &lt;call&gt; 
2635 to all clusters
2636 </tt>
2637
2638 <P>
2639 This command sends out any information held in the user file which can 
2640 be broadcast in PC41 protocol packets. This information is Name, QTH, Location
2641 and Homenode. PC41s are only sent for the information that is available.
2642
2643 <sect1>help (0)
2644
2645 <P>
2646 <tt>
2647 <bf>help &lt;cmd&gt;</bf> Get help on a command
2648 </tt>
2649
2650 <P>
2651 All commands can be abbreviated, so SHOW/DX can be abbreviated
2652 to SH/DX, ANNOUNCE can be shortened to AN and so on.
2653
2654 Look at the APROPOS &lt;string&gt; command which will search the help database
2655 for the &lt;string&gt; you specify and give you a list of likely commands
2656 to look at with HELP.
2657
2658 <sect1>init (5)
2659
2660 <P>
2661 <tt>
2662 <bf>init &lt;node call&gt;</bf> Re-initialise a link to an AK1A compatible node
2663 </tt>
2664
2665 <P>
2666 This command attempts to re-initialise a link to a (usually) AK1A node
2667 that has got confused, usually by a protocol loop of some kind. It may
2668 work - but you usually will be better off simply disconnecting it (or
2669 better, if it is a real AK1A node, doing an RCMD &lt;node&gt; DISC/F &lt;your
2670 node&gt;).
2671
2672 Best of luck - you will need it.
2673
2674 <sect1>kill (0)
2675
2676 <P>
2677 <tt>
2678 <bf>kill &lt;msgno&gt; &lsqb;&lt;msgno&gt; ..&rsqb;</bf> Delete a message 
2679 from the local system
2680 </tt>
2681
2682 <P>
2683 Delete a message from the local system. You will only be able to
2684 delete messages that you have originated or been sent (unless you are
2685 the sysop).
2686
2687 <sect1>kill (5)
2688
2689 <P>
2690 <tt>
2691 <bf>kill &lt;msgno&gt [&lt;msgno&gt; ...]</bf> Remove or erase a message from 
2692 the system<newline>
2693 <bf>kill from &lt;call&gt;</bf> Remove all messages from a callsign<newline>
2694 <bf>kill to &lt;call&gt;</bf> Remove all messages to a callsign<newline>
2695 </tt>
2696
2697 <P>
2698 You can get rid of any message to or originating from your callsign using 
2699 this command. You can remove more than one message at a time.
2700
2701 As a sysop you can kill any message on the system.
2702
2703 <sect1>kill full (5)
2704
2705 <P>
2706 <tt>
2707 <bf>kill full &lt;msgno&gt; &lsqb;&lt;msgno&gt;&rsqb;</bf> Delete a message from the 
2708 whole cluster
2709 </tt>
2710
2711 <P>
2712 Delete a message (usually a 'bulletin') from the whole cluster system. 
2713
2714 This uses the subject field, so any messages that have exactly the same subject
2715 will be deleted. Beware!
2716
2717 <sect1>links (0)
2718
2719 <P>
2720 <tt>
2721 <bf>links</bf> Show which nodes are physically connected
2722 </tt>
2723
2724 <P>
2725 This is a quick listing that shows which links are connected and
2726 some information about them. See WHO for a list of all connections.
2727
2728
2729 <sect1>load/aliases (9)
2730
2731 <P>
2732 <tt>
2733 <bf>load/aliases</bf> Reload the command alias table
2734 </tt>
2735
2736 <P>
2737 Reload the /spider/cmd/Aliases file after you have editted it. You will need to
2738 do this if you change this file whilst the cluster is running in order for the
2739 changes to take effect.
2740
2741
2742 <sect1>load/baddx (9)
2743
2744 <P>
2745 <tt>
2746 <bf>load/baddx</bf> Reload the bad DX table
2747 </tt>
2748
2749 <P>
2750 Reload the /spider/data/baddx.pl file if you have changed it manually whilst
2751 the cluster is running. This table contains the DX Calls that, if spotted, 
2752 will not be passed on. FR0G and TEST are classic examples.
2753
2754 <sect1>load/badmsg (9)
2755
2756 <P>
2757 <tt>
2758 <bf>load/badmsg</bf> Reload the bad message table
2759 </tt>
2760
2761 <P>
2762 Reload the /spider/msg/badmsg.pl file if you have changed it manually whilst
2763 the cluster is running. This table contains a number of perl regular 
2764 expressions which are searched for in the fields targetted of each message. 
2765 If any of them match then that message is immediately deleted on receipt. 
2766
2767 <sect1>load/badwords (9)
2768
2769 <P>
2770 <tt>
2771 <bf>load/badwords</bf> Reload the badwords file
2772 </tt>
2773
2774 <P>
2775 Reload the /spider/data/badwords file if you have changed it manually whilst
2776 the cluster is running. This file contains a list of words which, if found
2777 on certain text portions of PC protocol, will cause those protocol frames
2778 to be rejected. It will all put out a message if any of these words are
2779 used on the announce, dx and talk commands. The words can be one or 
2780 more on a line, lines starting with '#' are ignored.
2781
2782 <sect1>load/bands (9)
2783
2784 <P>
2785 <tt>
2786 <bf>load/bands</bf> Reload the band limits table
2787 </tt>
2788
2789 <P>
2790 Reload the /spider/data/bands.pl file if you have changed it manually whilst
2791 the cluster is running. 
2792
2793 <sect1>load/cmd_cache (9)
2794
2795 <P>
2796 <tt>
2797 <bf>load/cmd_cache</bf> Reload the automatic command cache
2798 </tt>
2799
2800 <P>
2801 Normally, if you change a command file in the cmd or local_cmd tree it will
2802 automatially be picked up by the cluster program. Sometimes it can get confused
2803 if you are doing a lot of moving commands about or delete a command in the 
2804 local_cmd tree and want to use the normal one again. Execute this command to
2805 reset everything back to the state it was just after a cluster restart.
2806
2807 <sect1>load/forward (9)
2808
2809 <P>
2810 <tt>
2811 <bf>load/forward</bf> Reload the msg forwarding routing table
2812 </tt>
2813
2814 Reload the /spider/msg/forward.pl file if you have changed it
2815 manually whilst the cluster is running.
2816
2817 <sect1>load/messages (9)
2818
2819 <P>
2820 <tt>
2821 <bf>load/messages</bf> Reload the system messages file
2822 </tt>
2823
2824 <P>
2825 If you change the /spider/perl/Messages file (usually whilst fiddling/writing ne
2826 commands) you can have them take effect during a cluster session by executing this
2827 command. You need to do this if get something like :-
2828
2829 unknown message 'xxxx' in lang 'en'
2830
2831 <sect1>load/prefixes (9)
2832
2833 <P>
2834 <tt>
2835 <bf>load/prefixes</bf> Reload the prefix table
2836 </tt>
2837
2838 <P>
2839 Reload the /spider/data/prefix_data.pl file if you have changed it manually 
2840 whilst the cluster is running. 
2841
2842 <sect1>merge (5)
2843
2844 <P>
2845 <tt>
2846 <bf>merge &lt;node&gt; [&lt;no spots&gt;/&lt;no wwv&gt;]</bf> Ask for the 
2847 latest spots and WWV
2848 </tt>
2849
2850 <P>
2851 MERGE allows you to bring your spot and wwv database up to date. By default
2852 it will request the last 10 spots and 5 WWVs from the node you select. The 
2853 node must be connected locally.
2854
2855 You can request any number of spots or wwv and although they will be appended
2856 to your databases they will not duplicate any that have recently been added 
2857 (the last 2 days for spots and last month for WWV data).
2858
2859 <sect1>msg (9)
2860
2861 <P>
2862 <tt>
2863 <bf>msg &lt;cmd&gt; &lt;msgno&gt; [data ...]</bf> Alter various message 
2864 parameters
2865 </tt>
2866
2867 <P>
2868 Alter message parameters like To, From, Subject, whether private or bulletin
2869 or return receipt (RR) is required or whether to keep this message from timing
2870 out.
2871
2872 <tscreen><verb>
2873   MSG TO <msgno> <call>     - change TO callsign to <call>
2874   MSG FRom <msgno> <call>   - change FROM callsign to <call>
2875   MSG PRrivate <msgno>      - set private flag
2876   MSG NOPRrivate <msgno>    - unset private flag
2877   MSG RR <msgno>            - set RR flag
2878   MSG NORR <msgno>          - unset RR flag
2879   MSG KEep <msgno>          - set the keep flag (message won't be deleted ever)
2880   MSG NOKEep <msgno>        - unset the keep flag
2881   MSG SUbject <msgno> <new> - change the subject to <new>
2882   MSG WAittime <msgno>      - remove any waitting time for this message
2883   MSG NOREad <msgno>        - mark message as unread
2884   MSG REad <msgno>          - mark message as read
2885   MSG QUeue                 - queue any outstanding bulletins
2886   MSG QUeue 1               - queue any outstanding private messages
2887 </verb></tscreen>
2888
2889 You can look at the status of a message by using:-
2890
2891   STAT/MSG &lt;msgno&gt;      
2892
2893 This will display more information on the message than DIR does.
2894
2895 <sect1>pc (8)
2896
2897 <P>
2898 <tt>
2899 <bf>pc &lt;call&gt; &lt;text&gt;</bf> Send text (eg PC Protocol) to &lt;call&gt;
2900 </tt>
2901
2902 <P>
2903 Send some arbitrary text to a locally connected callsign. No processing is done on
2904 the text. This command allows you to send PC Protocol to unstick things if problems
2905 arise (messages get stuck etc). eg:-
2906
2907    pc gb7djk PC33^GB7TLH^GB7DJK^400^
2908
2909 You can also use in the same way as a talk command to a connected user but
2910 without any processing, added of "from &lt;blah&gt; to &lt;blah&gt;" or whatever.
2911
2912    pc G1TLH Try doing that properly!!!
2913
2914 <sect1>ping (1)
2915
2916 <P>
2917 <tt>
2918 <bf>ping &lt;node&gt;</bf> Check the link quality between nodes
2919 </tt>
2920
2921 <P>
2922 his command allows you to send a frame to another cluster node on
2923 the network and get a return frame.  The time it takes to do this
2924 is a good indication of the quality of the link.  The actual time
2925 it takes is output to the console in seconds.
2926 Any visible cluster node can be PINGed.
2927
2928
2929 <sect1>rcmd (1)
2930
2931 <P>
2932 <tt>
2933 <bf>rcmd &lt;node call&gt; &lt;cmd&gt;</bf> Send a command to another DX cluster
2934 </tt>
2935
2936 <P>
2937 This command allows you to send nearly any command to another DX Cluster
2938 node that is connected to the system. 
2939
2940 Whether you get any output is dependant on a) whether the other system knows
2941 that the node callsign of this cluster is in fact a node b) whether the
2942 other system is allowing RCMDs from this node and c) whether you have
2943 permission to send this command at all.
2944
2945 <sect1>read (0)
2946
2947 <P>
2948 <tt>
2949 <bf>read</bf> Read the next unread personal message addressed to you<newline>
2950 <bf>read &lt;msgno&gt;</bf> Read the specified message<newline>
2951 </tt>
2952
2953 <P>
2954 You can read any messages that are sent as 'non-personal' and also any
2955 message either sent by or sent to your callsign.
2956
2957
2958 <sect1>read (extended for sysops) (5) 
2959
2960 <P>
2961 <tt>
2962 <bf>read &lt;msgno&gt;</bf> Read a message on the system
2963 </tt>
2964
2965 <P>
2966 As a sysop you may read any message on the system
2967
2968 <sect1>reject/announce
2969
2970 <P>
2971 <tt>
2972 <bf>reject/announce &lsqb;0-9&rsqb; &lt;pattern&gt;</bf> Set a reject filter
2973 for announce
2974 </tt>
2975
2976 <P>
2977 Create an 'reject this announce' line for a filter. 
2978
2979 An reject filter line means that if the announce matches this filter it is
2980 passed onto the user. See HELP FILTERS for more info. Please read this
2981 to understand how filters work - it will save a lot of grief later on.
2982
2983 You can use any of the following things in this line:-
2984
2985 <tscreen><verb>
2986   info <string>            eg: iota or qsl
2987   by <prefixes>            eg: G,M,2         
2988   origin <prefixes>
2989   origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
2990   origin_itu <numbers>
2991   origin_zone <numbers>
2992   by_dxcc <numbers>
2993   by_itu <numbers>
2994   by_zone <numbers>
2995   channel <prefixes>
2996   wx 1                     filter WX announces
2997   dest <prefixes>          eg: 6MUK,WDX      (distros)
2998 </verb></tscreen>
2999
3000 some examples:-
3001
3002 <tscreen><verb>
3003   rej/ann by_zone 14,15,16 and not by G,M,2
3004 </verb></tscreen>
3005  
3006 You can use the tag 'all' to reject everything eg:
3007
3008 <tscreen><verb>
3009   rej/ann all
3010 </verb></tscreen>
3011
3012 but this probably for advanced users...
3013
3014 <sect1>reject/announce (extended for sysops) (8)
3015
3016 <P>
3017 <tt>
3018 <bf>reject/announce &lt;call&gt; &lsqb;input&rsqb; &lsqb;0-9&rsqb; &lt;pattern&gt;</bf> Announce filter sysop version
3019 </tt>
3020
3021 <P>
3022 This version allows a sysop to set a filter for a callsign as well as the
3023 default for nodes and users eg:-
3024
3025 <tscreen><verb>
3026   reject/ann by G,M,2
3027   reject/ann input node_default by G,M,2
3028   reject/ann user_default by G,M,2
3029 </verb></tscreen>
3030
3031 <sect1>reject/spots (0)
3032
3033 <P>
3034 <tt>
3035 <bf>reject/spots &lsqb;0-9&rsqb; &lt;pattern&gt;</bf> Set a reject filter 
3036 line for spots
3037 </tt>
3038
3039 <P>
3040 Create a 'reject this spot' line for a filter. 
3041
3042 A reject filter line means that if the spot matches this filter it is
3043 dumped (not passed on). See HELP FILTERS for more info. Please read this
3044 to understand how filters work - it will save a lot of grief later on.
3045
3046 You can use any of the following things in this line:-
3047
3048 <tscreen><verb>
3049   freq <range>           eg: 0/30000 or hf or hf/cw or 6m,4m,2m
3050   on <range>             same as 'freq'
3051   call <prefixes>        eg: G,PA,HB9
3052   info <string>          eg: iota or qsl
3053   by <prefixes>            
3054   call_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
3055   call_itu <numbers>
3056   call_zone <numbers>
3057   by_dxcc <numbers>
3058   by_itu <numbers>
3059   by_zone <numbers>
3060   origin <prefixes>
3061   channel <prefixes>
3062 </verb></tscreen>
3063
3064 For frequencies, you can use any of the band names defined in
3065 SHOW/BANDS and you can use a subband name like: cw, rtty, data, ssb -
3066 thus: hf/ssb. You can also just have a simple range like: 0/30000 -
3067 this is more efficient than saying simply: on HF (but don't get
3068 too hung up about that)
3069
3070 some examples:-
3071
3072 <tscreen><verb>
3073   rej/spot 1 on hf
3074   rej/spot 2 on vhf and not (by_zone 14,15,16 or call_zone 14,15,16)
3075 </verb></tscreen>
3076
3077 You can use the tag 'all' to reject everything eg:
3078
3079 <tscreen><verb>
3080   rej/spot 3 all
3081 </verb></tscreen>
3082
3083 but this probably for advanced users...
3084
3085 <sect1>reject/spots (extended for sysops) (8)
3086
3087 <P>
3088 <tt>
3089 <bf>reject/spots &lt;call&gt; &lsqb;input&rsqb; &lsqb;0-9&rsqb; &lt;pattern&gt;</bf>
3090  Reject spot filter sysop version 
3091 </tt>
3092
3093 <P>
3094 This version allows a sysop to set a filter for a callsign as well as the
3095 default for nodes and users eg:-
3096
3097 <tscreen><verb>
3098   reject/spot db0sue-7 1 by_zone 14,15,16
3099   reject/spot node_default all
3100   set/hops node_default 10
3101
3102   reject/spot user_default by G,M,2
3103 </verb></tscreen>
3104
3105 <sect1>reject/wcy (0)
3106
3107 <P>
3108 <tt>
3109 <bf>reject/wcy &lsqb;0-9&rsqb; &lt;pattern&gt;</bf> Set a reject WCY filter
3110 </tt>
3111
3112 <P>
3113 It is unlikely that you will want to do this, but if you do then you can
3114 filter on the following fields:-
3115
3116 <tscreen><verb>
3117   by <prefixes>            eg: G,M,2         
3118   origin <prefixes>
3119   origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
3120   origin_itu <numbers>
3121   origin_zone <numbers>
3122   by_dxcc <numbers>
3123   by_itu <numbers>
3124   by_zone <numbers>
3125   channel <prefixes>
3126 </verb></tscreen>
3127
3128 There are no examples because WCY Broadcasts only come from one place and
3129 you either want them or not (see UNSET/WCY if you don't want them).
3130
3131 This command is really provided for future use.
3132
3133 See HELP FILTER for information.
3134
3135 <sect1>reject/wcy (extended for sysops) (8)
3136
3137 <P>
3138 <tt>
3139 <bf>reject/wcy &lt;call&gt; &lsqb;input&rsqb; &lsqb;0-9&rsqb; &lt;pattern&gt;</bf>
3140  WCY reject filter sysop version
3141 </tt>
3142
3143 <P>
3144 This version allows a sysop to set a filter for a callsign as well as the
3145 default for nodes and users eg:-
3146
3147   reject/wcy gb7djk all
3148
3149 <sect1>reject/wwv (0)
3150
3151 <P>
3152 <tt>
3153 <bf>reject/wwv &lsqb;0-9&rsqb; &lt;pattern&gt;</bf> Set a reject WWV filter
3154 </tt>
3155
3156 <P>
3157 It is unlikely that you will want to do this, but if you do then you can
3158 filter on the following fields:-
3159
3160 <tscreen><verb>
3161   by <prefixes>            eg: G,M,2         
3162   origin <prefixes>
3163   origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
3164   origin_itu <numbers>
3165   origin_zone <numbers>
3166   by_dxcc <numbers>
3167   by_itu <numbers>
3168   by_zone <numbers>
3169   channel <prefixes>
3170 </verb></tscreen>
3171
3172 for example 
3173
3174 <tscreen><verb>
3175   reject/wwv by_zone 14,15,16
3176 </verb></tscreen>
3177
3178 is probably the only useful thing to do (which will only show WWV broadcasts
3179 by stations in the US).
3180
3181 See HELP FILTER for information.
3182
3183 <sect1>reject/wwv (extended for sysops) (8)
3184
3185 <P>
3186 <tt>
3187 <bf>reject/wwv &lt;call&gt; &lsqb;input&rsqb; &lsqb;0-9&rsqb; &lt;pattern&gt;</bf>
3188  WWV reject filter sysop version
3189 </tt>
3190
3191 <P>This version allows a sysop to set a filter for a callsign as well as the
3192 default for nodes and users eg:-
3193
3194 <tscreen><verb>
3195   reject/wwv db0sue-7 1 by_zone 4
3196   reject/wwv node_default all
3197
3198   reject/wwv user_default by W
3199 </verb></tscreen>
3200
3201 <sect1>reply (0)
3202
3203 <P>
3204 <tt>
3205 <bf>reply</bf> Reply (privately) to the last message that you have read<newline>
3206 <bf>reply &lt;msgno&gt;</bf> Reply (privately) to the specified message<newline>
3207 <bf>reply B &lt;msgno&gt;</bf> Reply as a Bulletin to the specified message<newline>
3208 <bf>reply NOPrivate &lt;msgno&gt;</bf> Reply as a Bulletin to the specified
3209 message<newline>
3210 <bf>reply RR &lt;msgno&gt;</bf> Reply to the specified message with read 
3211 receipt<newline>
3212 </tt>
3213
3214 <P>
3215 You can reply to a message and the subject will automatically have
3216 "Re:" inserted in front of it, if it isn't already present.
3217
3218 You can also use all the extra qualifiers such as RR, PRIVATE, 
3219 NOPRIVATE, B that you can use with the SEND command (see SEND
3220 for further details)
3221
3222 <sect1>send (0)
3223
3224 <P>
3225 <tt>
3226 <bf>send &lt;call&gt; &lsqb;&lt;call&gt; ...&rsqb;</bf> Send a message to 
3227 one or more callsigns<newline>
3228 <bf>send RR &lt;call&gt;</bf> Send a message and ask for a read receipt<newline>
3229 <bf>send COPY &lt;msgno&gt; &lt;call&gt;</bf> Send a copy of a  message 
3230 to someone<newline>
3231 <bf>send PRIVATE &lt;call&gt;</bf> Send a personal message<newline>
3232 <bf>send NOPRIVATE &lt;call&gt;</bf> Send a message to all stations<newline>
3233 </tt>
3234
3235 <P>
3236 All the SEND commands will create a message which will be sent either to
3237 an individual callsign or to one of the 'bulletin' addresses. 
3238
3239 SEND &lt;call&gt; on its own acts as though you had typed SEND PRIVATE, that is
3240 it will mark the message as personal and send it to the cluster node that
3241 that callsign is connected to.
3242
3243 You can have more than one callsign in all of the SEND commands.
3244
3245 You can have multiple qualifiers so that you can have for example:-
3246
3247 <tscreen><verb>
3248   SEND RR COPY 123 PRIVATE G1TLH G0RDI
3249 </verb></tscreen>
3250
3251 which should send a copy of message 123 to G1TLH and G0RDI and you will
3252 receive a read receipt when they have read the message.
3253
3254 SB is an alias for SEND NOPRIVATE (or send a bulletin in BBS speak)
3255 SP is an alias for SEND PRIVATE
3256
3257 <sect1>set/address (0)
3258
3259 <P>
3260 <tt>
3261 <bf>set/address &lt;your_address&gt;</bf> Record your postal address
3262 </tt>
3263
3264 <P>
3265 Literally, record your address details on the cluster.
3266
3267 <sect1>set/announce (0)
3268
3269 <P>
3270 <tt>
3271 <bf>set/announce</bf> Allow announce messages
3272 </tt>
3273
3274 <P>
3275 Allow announce messages to arrive at your terminal.
3276
3277 <sect1>set/arcluster (5)
3278
3279 <P>
3280 <tt>
3281 <bf>set/arcluster &lt;node_call&gt; &lsqb;&lt;node_call&gt; ...&rsqb;</bf> Make
3282 the node_call an AR-Cluster type node
3283 </tt>
3284
3285 <P>
3286 Set the node_call as an AR-Cluster type node
3287
3288 <sect1>set/baddx (8)
3289
3290 <P>
3291 <tt>
3292 <bf>set/baddx &lt;call&gt;</bf> Stop words we do not wish to see in the callsign field
3293 of a dx spot being propagated
3294 </tt>
3295
3296 <P>
3297 Setting a word as 'baddx' will prevent spots with that word in the callsign 
3298 field of a DX spot from going any further. They will not be displayed and they 
3299 will not be sent onto other nodes.
3300
3301 The word must be wriiten in full, no wild cards are allowed eg:-
3302
3303 <tscreen><verb>
3304   set/baddx FORSALE VIDEO FR0G 
3305 </verb></tscreen>
3306
3307 To allow a word again, use the following command ...
3308
3309 <tscreen><verb>
3310   unset/baddx VIDEO
3311 </verb></tscreen>
3312
3313 <sect1>set/badnode (6)
3314
3315 <P>
3316 <tt>
3317 <bf>set/badnode &lt;node_call&gt;</bf> Stop spots from this node_call
3318 being propagated
3319 </tt>
3320
3321 <P>
3322 Setting a callsign as a 'badnode' will prevent spots from that node 
3323 going any further. They will not be displayed and they will not be 
3324 sent onto other nodes.
3325
3326 The call can be a full or partial call (or a prefix), eg:-
3327
3328 <tscreen><verb>
3329   set/badnode K1TTT 
3330 </verb></tscreen>
3331
3332 will stop anything from K1TTT (including any SSID's)
3333
3334 <tscreen><verb>
3335   unset/badnode K1TTT
3336 </verb></tscreen>
3337
3338 will allow spots from him again.
3339
3340 Use with extreme care. This command may well be superceded by FILTERing.
3341
3342 <sect1>set/badspotter (8)
3343
3344 <P>
3345 <tt>
3346 <bf>set/badspotter &lt;call&gt;</bf> Stop spots from this callsign being propagated
3347 </tt>
3348
3349 <P>
3350 Setting a callsign as a 'badspotter' will prevent spots from this callsign 
3351 going any further. They will not be displayed and they will not be 
3352 sent onto other nodes.
3353
3354 The call must be written in full, no wild cards are allowed eg:-
3355
3356 <tscreen><verb>
3357   set/badspotter VE2STN 
3358 </verb></tscreen>
3359
3360 will stop anything from VE2STN. If you want SSIDs as well then you must
3361 enter them specifically.
3362
3363 <tscreen><verb>
3364   unset/badspotter VE2STN
3365 </verb></tscreen>
3366
3367 will allow spots from him again.
3368
3369 Use with extreme care. This command may well be superceded by FILTERing.
3370
3371 <sect1>set/beep (0)
3372
3373 <P>
3374 <tt>
3375 <bf>set/beep</bf> Add beeps to terminal messages
3376 </tt>
3377
3378 <P>
3379 Add a beep to DX and other terminal messages.
3380
3381 <sect1>set/clx (5)
3382
3383 <P>
3384 <tt>
3385 <bf>set/clx &lt;node_call&gt; &lsqb;&lt;node_call&gt; ...&rsqb;</bf> Make
3386 the node_call a CLX type node
3387 </tt>
3388
3389 <P>
3390 Set the node_call as a CLX type node
3391
3392 <sect1>set/debug (9)
3393
3394 <P>
3395 <tt>
3396 <bf>set/debug &lt;name&gt;</bf> Add a debug level to the debug set
3397 </tt>
3398
3399 <P>
3400 You can remove this level with unset/debug &lt;name&gt;
3401
3402 <sect1>set/dx (0)
3403
3404 <P>
3405 <tt>
3406 <bf>set/dx</bf>Allow DX messages to arrive at your terminal
3407 </tt>
3408
3409 <P>
3410 You can stop DX messages with the <em>unset/dx</em> command
3411
3412 <sect1>set/dxgrid (0)
3413
3414 <P>
3415 <tt>
3416 <bf>set/dxgrid</bf>Allow grid squares on the end of DX messages
3417 </tt>
3418
3419 <P>
3420 Some logging programs do not like the additional information at
3421 the end of a DX spot.  If this is the case, use the <em>unset/dxgrid</em>
3422 command to remove the grid squares.
3423
3424 <sect1>set/dxnet (5)
3425
3426 <P>
3427 <tt>
3428 <bf>set/dxnet &lt;node_call&gt; &lsqb;&lt;node_call&gt; ...&rsqb;</bf> Make
3429 the node_call a DXNet type node
3430 </tt>
3431
3432 <P>
3433 Set the node_call as a DXNet type node
3434
3435 <sect1>set/echo (0)
3436
3437 <P>
3438 <tt>
3439 <bf>set/echo</bf> Make the cluster echo your input
3440 </tt>
3441
3442 <P>
3443 If you are connected via a telnet session, different implimentations
3444 of telnet handle echo differently depending on whether you are 
3445 connected via port 23 or some other port. You can use this command
3446 to change the setting appropriately. 
3447
3448 You can remove the echo with the <em>unset/echo</em> command
3449
3450 The setting is stored in your user profile.
3451
3452 YOU DO NOT NEED TO USE THIS COMMAND IF YOU ARE CONNECTED VIA AX25.
3453
3454 <sect1>set/here (0)
3455
3456 <P>
3457 <tt>
3458 <bf>set/here</bf> Set the here flag
3459 </tt>
3460
3461 <P>
3462 Let others on the cluster know you are here by only displaying your
3463 callsign.  If you are away from your terminal you can use the <em>unset/here</em>
3464 command to let people know you are away.  This simply puts brackets
3465 around your callsign to indicate you are not available.
3466
3467 <sect1>set/homenode (0)
3468
3469 <P>
3470 <tt>
3471 <bf>set/homenode &lt;node_call&gt;</bf> Set your home cluster
3472 </tt>
3473
3474 <P>
3475 Tell the cluster system where you normally connect to. Any Messages sent
3476 to you will normally find their way there should you not be connected.
3477 eg:-
3478
3479 <tscreen><verb>
3480   SET/HOMENODE gb7djk
3481 </verb></tscreen>
3482
3483 <sect1>set/hops (8)
3484
3485 <P>
3486 <tt>
3487 <bf>set/hops &lt;node_call&gt; ann&verbar;spots&verbar;wwv&verbar;wcy &lt;n&gt;</bf>
3488 Set hop count
3489 </tt>
3490
3491 <P>
3492 Set the hop count for a particular type of broadcast for a node.
3493
3494 This command allows you to set up special hop counts for a node 
3495 for currently: announce, spots, wwv and wcy broadcasts.
3496
3497 <tscreen><verb>
3498 eg:
3499   set/hops gb7djk ann 10
3500   set/hops gb7mbc spots 20
3501 </verb></tscreen>
3502
3503 Set SHOW/HOPS for information on what is already set. This command
3504 creates a filter and works in conjunction with the filter system. 
3505
3506 <sect1>set/isolate (9)
3507
3508 <P>
3509 <tt>
3510 <bf>set/isolate &lt;node call&gt;</bf> Isolate a node from the rest of the network
3511 </tt>
3512
3513 <P>
3514 Connect a node to your system in such a way that you are a full protocol
3515 member of its network and can see all spots on it, but nothing either leaks
3516 out from it nor goes back into from the rest of the nodes connected to you.
3517
3518 You can potentially connect several nodes in this way.
3519
3520 You can see which nodes are isolated with the show/isolate (1) command.
3521
3522 You can remove the isolation with the command unset/isolate.
3523
3524 <sect1>set/language (0)
3525
3526 <P>
3527 <tt>
3528 <bf>set/language &lt;language&gt;</bf> Set the language you wish to use
3529 </tt>
3530
3531 <P>
3532 You can select the language that you want the cluster to use. Currently
3533 the languages available are <em>en</em> (English) and <em>nl</em> (Dutch).
3534
3535 <sect1>set/location (0)
3536
3537 <P>
3538 <tt>
3539 <bf>set/location &lt;lat and long&gt;</bf> Set your latitude and longitude
3540 </tt>
3541
3542 <P>
3543 You can set your latitude and longitude manually or alternatively use the
3544 <em>set/qra</em> command which will do the conversion for you.
3545
3546 <tscreen><verb>
3547   set/location 54 04 N 2 02 E
3548 </verb></tscreen>
3549
3550
3551 <sect1>set/sys_location (9)
3552
3553 <P>
3554 <tt>
3555 <bf>set/sys_location &lt;lat & long&gt;</bf> Set your cluster latitude and longitude
3556 </tt>
3557
3558 <P>
3559 In order to get accurate headings and such like you must tell the system
3560 what your latitude and longitude is. If you have not yet done a SET/QRA
3561 then this command will set your QRA locator for you. For example:-
3562
3563 <tscreen><verb>
3564   SET/LOCATION 52 22 N 0 57 E
3565 </verb></tscreen>
3566
3567 <sect1>set/logininfo (0)
3568
3569 <P>
3570 <tt>
3571 <bf>set/logininfo</bf> Show logins and logouts of nodes and users
3572 </tt>
3573
3574 <P>
3575 Show users and nodes when they log in and out of the local cluster.  You
3576 can stop these messages by using the <em>unset/logininfo</em> command.
3577
3578
3579 <sect1>set/lockout (9)
3580
3581 <P>
3582 <tt>
3583 <bf>set/lockout &lt;call&gt;</bf> Stop a callsign connecting to the cluster
3584 </tt>
3585
3586 <P>
3587 You can show who is locked out with the <em>show/lockout</em> command.
3588 To allow the user to connect again, use the <em>unset/lockout</em> command.
3589
3590 <sect1>set/name (0)
3591
3592 <P>
3593 <tt>
3594 <bf>set/name &lt;your_name&gt;</bf> Set your name
3595 </tt>
3596
3597 <P>
3598 Tell the cluster what your name is, eg:-
3599
3600 <tscreen><verb>
3601   set/name Dirk
3602 </verb></tscreen>
3603
3604 <sect1>set/node (9)
3605
3606 <P>
3607 <tt>
3608 <bf>set/node &lt;call&gt; [&lt;call&gt; ...]</bf> Make the callsign an AK1A cluster
3609 </tt>
3610
3611 <P>
3612 Tell the system that the call(s) are to be treated as AK1A cluster and
3613 fed PC Protocol rather normal user commands.
3614
3615 From version 1.41 you can also set the following types of cluster
3616
3617 <tscreen><verb>
3618   set/spider
3619   set/dxnet
3620   set/clx
3621   set/arcluster
3622 </verb></tscreen>
3623
3624 To see what your nodes are set to, use the <em>show/nodes</em> command.
3625
3626 <sect1>set/obscount (9)
3627
3628 <P>
3629 <tt>
3630 <bf>set/obscount &lt;count&gt; &lt;node call&gt;</bf> Set the 'pump-up' 
3631 obsolescence counter
3632 </tt>
3633
3634 <P>
3635 From version 1.35 onwards neighbouring nodes are pinged at regular intervals (see
3636 SET/PINGINTERVAL), usually 300 seconds or 5 minutes. There is a 'pump-up'
3637 counter which is decremented on every outgoing ping and then reset to
3638 the 'obscount' value on every incoming ping. The default value of this
3639 parameter is 2. 
3640
3641 What this means is that a neighbouring node will be pinged twice at 
3642 (default) 300 second intervals and if no reply has been heard just before
3643 what would be the third attempt, that node is disconnected.
3644
3645 If a ping is heard then the obscount is reset to the full value. Using
3646 default values, if a node has not responded to a ping within 15 minutes,
3647 it is disconnected.
3648
3649 <sect1>set/page (0)
3650
3651 <P>
3652 <tt>
3653 <bf>set/page &lt;n&gt;</bf> Set the number of lines per page
3654 </tt>
3655
3656 <P>
3657 Tell the system how many lines you wish on a page when the number of lines
3658 of output from a command is more than this. The default is 20. Setting it
3659 explicitly to 0 will disable paging. 
3660
3661 <tscreen><verb>
3662   SET/PAGE 30
3663   SET/PAGE 0
3664 </verb></tscreen>
3665
3666 The setting is stored in your user profile.
3667
3668
3669 <sect1>set/password (9)
3670
3671 <P>
3672 <tt>
3673 <bf>set/password &lt;callsign&gt; &lt;string&gt;</bf> Set a users password
3674 </tt>
3675
3676 <P>
3677 The password for a user can only be set by a full sysop. The string
3678 can contain any characters but any spaces are removed (you can type in
3679 spaces - but they won't appear in the password). You can see the
3680 result with STAT/USER.  The password is the usual 30 character baycom
3681 type password.
3682
3683 <sect1>set/pinginterval (9)
3684
3685 <P>
3686 <tt>
3687 <bf>set/pinginterval &lt;time&gt; &lt;node call&gt;</bf> Set the ping time 
3688 to neighbouring nodes
3689 </tt>
3690
3691 <P>
3692 As from version 1.35 all neighbouring nodes are pinged at regular intervals
3693 in order to determine the rolling quality of the link and, in future, to
3694 affect routing decisions. The default interval is 300 secs or 5 minutes.
3695
3696 You can use this command to set a different interval. Please don't. 
3697
3698 But if you do the value you enter is treated as minutes up 60 and seconds
3699 for numbers greater than that.
3700
3701 This is used also to help determine when a link is down at the far end
3702 (as certain cluster software doesn't always notice), see SET/OBSCOUNT
3703 for more information.
3704
3705 <sect1>set/privilege (9)
3706
3707 <P>
3708 <tt>
3709 <bf>set/privilege &lt;n&gt; &lt;call&gt; [&lt;call&gt; ...]</bf> Set the 
3710 privilege level on a call
3711 </tt>
3712
3713 <P>
3714 Set the privilege level on a callsign. The privilege levels that pertain
3715 to commands are as default:-
3716
3717 <tscreen><verb>
3718   0 - normal user
3719   1 - allow remote nodes normal user RCMDs
3720   5 - various privileged commands (including shutdown, but not disc-
3721       connect), the normal level for another node.
3722   8 - more privileged commands (including disconnect)
3723   9 - local sysop privilege. DO NOT SET ANY REMOTE USER OR NODE TO THIS
3724       LEVEL.
3725 </verb></tscreen>
3726
3727 If you are a sysop and you come in as a normal user on a remote connection
3728 your privilege will automatically be set to 0.
3729
3730 <sect1>set/spider (5)
3731
3732 <P>
3733 <tt>
3734 <bf>set/spider &lt;node_call&gt; &lsqb;&lt;node_call&gt; ...&rsqb;</bf> Make
3735 the node_call a DXSpider type node
3736 </tt>
3737
3738 <P>
3739 Set the node_call as a DXSpider type node
3740
3741 <sect1>set/sys_qra (9)
3742
3743 <P>
3744 <tt>
3745 <bf>set/sys_qra &lt;locator&gt;</bf> Set your cluster QRA locator
3746 </tt>
3747
3748 <sect1>set/qra (0)
3749
3750 <P>
3751 <tt>
3752 <bf>set/qra &lt;locator&gt;</bf> Set your QRA locator
3753 </tt>
3754
3755 <P>
3756 Tell the system what your QRA (or Maidenhead) locator is. If you have not
3757 done a SET/LOCATION then your latitude and longitude will be set roughly
3758 correctly (assuming your locator is correct ;-). For example:-
3759
3760 <tscreen><verb>
3761   SET/QRA JO02LQ
3762 </verb></tscreen>
3763
3764 <sect1>set/qth (0)
3765
3766 <P>
3767 <tt>
3768 <bf>set/qth &lt;your QTH&gt;</bf> Set your QTH
3769 </tt>
3770
3771 <P>
3772 Tell the system where your are.  For example:-
3773
3774 <tscreen><verb>
3775   set/qth East Dereham, Norfolk
3776 </verb></tscreen>
3777
3778 <sect1>set/talk (0)
3779
3780 <P>
3781 <tt>
3782 <bf>set/talk</bf> Allow talk messages to be seen at your console
3783 </tt>
3784
3785 <P>
3786 Allow talk messages to arrive at your console.  You can switch off
3787 talks with the <em>unset/talk</em> command.
3788
3789 <sect1>set/wcy (0)
3790
3791 <P>
3792 <tt>
3793 <bf>set/wcy</bf> Allow WCY messages to be seen at your console
3794 </tt>
3795
3796 <P>
3797 Allow WCY information to be seen at your console.  You can switch off
3798 WCY messages with the <em>unset/wcy</em> command.
3799
3800 <sect1>set/wwv (0)
3801
3802 <P>
3803 <tt>
3804 <bf>set/wwv</bf> Allow WWV messages to be seen at your console
3805 </tt>
3806
3807 <P>
3808 Allow WWV information to be seen at your console.  You can switch off
3809 WWV messages with the <em>unset/wwv</em> command.
3810
3811 <sect1>set/wx (0)
3812
3813 <P>
3814 <tt>
3815 <bf>set/wx</bf> Allow WX messages to be seen at your console
3816 </tt>
3817
3818 <P>
3819 Allow WX information to be seen at your console.  You can switch off
3820 WX messages with the <em>unset/wx</em> command.
3821
3822 <sect1>show/baddx (1)
3823
3824 <P>
3825 <tt>
3826 <bf>show/baddx</bf>Show all the bad dx calls in the system
3827 </tt>
3828
3829 <P>
3830 Display all the bad dx callsigns in the system, see SET/BADDX
3831 for more information.
3832
3833 <sect1>show/badnode (6)
3834
3835 <P>
3836 <tt>
3837 <bf>show/badnode</bf> Show all the bad nodes in the system
3838 </tt>
3839
3840 <P>
3841 Display all the bad node callsigns in the system, see SET/BADNODE
3842 for more information.
3843
3844 <sect1>show/badspotter (1)
3845
3846 <P>
3847 <tt>
3848 <bf>show/badspotter</bf>Show all the bad spotters in the system
3849 </tt>
3850
3851 <P>
3852 Display all the bad spotter's callsigns in the system, see SET/BADSPOTTER
3853 for more information.
3854
3855 <sect1>show/date (0)
3856
3857 <P>
3858 <tt>
3859 <bf>show/date &lsqb;&lt;prefix&gt;&verbar;&lt;callsign&gt;&rsqb;</bf> Show
3860 the local time
3861 </tt>
3862
3863 <P>
3864 This is very nearly the same as SHOW/TIME, the only difference the format
3865 of the date string if no arguments are given.
3866
3867 If no prefixes or callsigns are given then this command returns the local
3868 time and UTC as the computer has it right now. If you give some prefixes
3869 then it will show UTC and UTC + the local offset (not including DST) at
3870 the prefixes or callsigns that you specify.
3871
3872 <sect1>show/dx (0)
3873
3874 <P>
3875 <tt>
3876 <bf>show/dx &lsqb;options&rsqb;</bf> interrogate the spot database
3877 </tt>
3878
3879 <P>
3880 If you just type SHOW/DX you will get the last so many spots
3881 (sysop configurable, but usually 10).
3882    
3883 In addition you can add any number of these options in very nearly
3884 any order to the basic SHOW/DX command, they are:-
3885
3886 <tscreen><verb>   
3887 on &lt;band&gt;       - eg 160m 20m 2m 23cm 6mm
3888 on &lt;region&gt;     - eg hf vhf uhf shf      (see SHOW/BANDS)
3889    
3890 &lt;number&gt;        - the number of spots you want
3891 &lt;from&gt;-&lt;to&gt     - &lt;from&gt; spot no &lt;to&gt; spot no in 
3892                   the selected list
3893    
3894 &lt;prefix&gt;        - for a spotted callsign beginning with &lt;prefix&gt;
3895 *&lt;suffix&gt;       - for a spotted callsign ending in &lt;suffix&gt;
3896 *&lt;string&gt;*      - for a spotted callsign containing &lt;string&gt;
3897    
3898 day &lt;number&gt;    - starting &lt;number&gt; days ago
3899 day &lt;from&gt;-&lt;to&gt; - &lt;from&gt; days &lt;to&gt; days ago
3900    
3901 info &lt;text&gt;     - any spots containing &lt;text&gt; in the info or remarks
3902    
3903 by &lt;call&gt;       - any spots spotted by &lt;call&gt; (spotter &lt;call&gt; 
3904                         is the same).
3905
3906 qsl             - this automatically looks for any qsl info on the call
3907                   held in the spot database.
3908
3909 iota &lsqb;&lt;iota&gt;&rsqb;   - If the iota island number is missing it will 
3910                   look for the string iota and anything which looks like 
3911                   an iota island number. If you specify then it will look 
3912                   for that island.
3913
3914 qra &lsqb;&lt;locator&gt;&rsqb; - this will look for the specific locator if 
3915                   you specify one or else anything that looks like a locator.
3916 </verb></tscreen>
3917    
3918 e.g. 
3919
3920 <tscreen><verb>   
3921    SH/DX 9m0
3922    SH/DX on 20m info iota
3923    SH/DX 9a on vhf day 30
3924    SH/DX rf1p qsl
3925    SH/DX iota 
3926    SH/DX iota eu-064
3927    SH/DX qra jn86
3928 </verb></tscreen>
3929
3930 <sect1>show/dxcc (0)
3931
3932 <P>
3933 <tt>
3934 <bf>show/dxcc &lt;prefix&gt;</bf> Interrogate the spot database by country
3935 </tt>
3936
3937 <P>
3938 This command takes the &lt;prefix&gt; (which can be a full or partial 
3939 callsign if desired), looks up which internal country number it is
3940 and then displays all the spots as per SH/DX for that country.
3941    
3942 The options for SHOW/DX also apply to this command.   
3943 e.g. 
3944
3945 <tscreen><verb>   
3946    SH/DXCC G
3947    SH/DXCC W on 20m info iota
3948 </verb></tscreen>
3949
3950 <sect1>show/files (0)
3951
3952 <P>
3953 <tt>
3954 <bf>show/files &lsqb;&lt;filearea&gt; &lsqb;&lt;string&gt;&rsqb;&rsqb;</bf> List
3955 the contents of a filearea
3956 </tt>
3957
3958 <P>
3959 SHOW/FILES on its own will show you a list of the various fileareas
3960 available on the system. To see the contents of a particular file
3961 area type:-
3962
3963 <tscreen><verb>
3964    SH/FILES &lt;filearea&gt;
3965 </verb></tscreen>
3966
3967 where &lt;filearea&gt; is the name of the filearea you want to see the 
3968 contents of.
3969
3970 You can also use shell globbing characters like '*' and '?' in a
3971 string to see a selection of files in a filearea eg:-
3972
3973 <tscreen><verb>
3974    SH/FILES bulletins arld*
3975 </verb></tscreen>
3976
3977 See also TYPE - to see the contents of a file.
3978
3979 <sect1>show/filter (0)
3980
3981 <P>
3982 <tt>
3983 <bf>show/filter</bf> Show the filters you have set
3984 </tt>
3985
3986 <P>
3987 Show the contents of all the filters that are set by you. This command 
3988 displays all the filters set - for all the various categories.
3989
3990 <sect1>show/filter (extended for sysops) (5)
3991
3992 <P>
3993 <tt>
3994 <bf>show/filter &lt;callsign&gt;</bf> Show the filters set by &lt;callsign&gt;
3995 </tt>
3996
3997 <P>
3998 A sysop can look at any filters that have been set.
3999
4000 <sect1>show/hops (8)
4001
4002 <P>
4003 <tt>
4004 <bf>show/hops &lt;node_call&gt; &lsqb;ann&verbar;spots&verbar;wcy&verbar;wwv&verbar;&rsqb;</bf> Show the hop 
4005 counts for a node
4006 </tt>
4007
4008 <P>
4009 This command shows the hop counts set up for a node. You can specify
4010 which category you want to see. If you leave the category out then 
4011 all the categories will be listed.
4012
4013 <sect1>show/isolate (1)
4014
4015 <P>
4016 <tt>
4017 <bf>show/isolate</bf> Show a list of isolated nodes
4018 </tt>
4019
4020 <P>
4021 Show which nodes are currently set to be isolated.
4022
4023 <sect1>show/lockout (9)
4024
4025 <P>
4026 <tt>
4027 <bf>show/lockout</bf> Show a list of excluded callsigns
4028 </tt>
4029
4030 <P>
4031 Show a list of callsigns that have been excluded (locked out) of the
4032 cluster locally with the <em>set/lockout</em> command
4033
4034 <sect1>show/moon (0)
4035
4036 <P>
4037 <tt>
4038 <bf>show/moon &lsqb;&lt;prefix&gt;&verbar;&lt;callsign&gt;&rsqb;</bf> Show moon
4039 rise and set times
4040 </tt>
4041
4042 <P>
4043 Show the Moon rise and set times for a (list of) prefixes or callsigns, 
4044 together with the azimuth and elevation of the sun currently at those
4045 locations.
4046
4047 If you don't specify any prefixes or callsigns, it will show the times for
4048 your QTH (assuming you have set it with either SET/LOCATION or SET/QRA),
4049 together with the current azimuth and elevation.
4050
4051 In addition, it will show the gain or loss dB relative to the nominal 
4052 distance of 385,000Km due to the ellipsoidal nature of the orbit.
4053
4054 If all else fails it will show the Moonrise and set times for the node
4055 that you are connected to. 
4056
4057 For example:-
4058
4059 <tscreen><verb>
4060   SH/MOON
4061   SH/MOON G1TLH W5UN
4062 </verb></tscreen>
4063
4064 <sect1>show/muf (0)
4065
4066 <P>
4067 <tt>
4068 <bf>show/muf &lt;prefix&gt; &lsqb;&lt;hours&gt;&rsqb;&lsqb;long&rsqb;</bf> Show
4069 the likely propagation to &lt;prefix&gt;
4070 </tt>
4071
4072 <P>
4073 This command allow you to estimate the likelihood of you contacting
4074 a station with the prefix you have specified. The output assumes a modest
4075 power of 20dBW and receiver sensitivity of -123dBm (about 0.15muV/10dB SINAD)
4076
4077 The result predicts the most likely operating frequencies and signal
4078 levels for high frequency (shortwave) radio propagation paths on
4079 specified days of the year and hours of the day. It is most useful for
4080 paths between 250 km and 6000 km, but can be used with reduced accuracy
4081 for paths shorter or longer than this.
4082
4083 The command uses a routine MINIMUF 3.5 developed by the U.S. Navy and
4084 used to predict the MUF given the predicted flux, day of the year,
4085 hour of the day and geographic coordinates of the transmitter and
4086 receiver. This routine is reasonably accurate for the purposes here,
4087 with a claimed RMS error of 3.8 MHz, but much smaller and less complex
4088 than the programs used by major shortwave broadcasting organizations,
4089 such as the Voice of America.
4090
4091 The command will display some header information detailing its
4092 assumptions, together with the locations, latitude and longitudes and
4093 bearings. It will then show UTC (UT), local time at the other end
4094 (LT), calculate the MUFs, Sun zenith angle at the midpoint of the path
4095 (Zen) and the likely signal strengths. Then for each frequency for which
4096 the system thinks there is a likelihood of a circuit it prints a value.
4097
4098 The value is currently a likely S meter reading based on the conventional
4099 6dB / S point scale. If the value has a '+' appended it means that it is
4100 1/2 an S point stronger. If the value is preceeded by an 'm' it means that
4101 there is likely to be much fading and by an 's' that the signal is likely
4102 to be noisy.  
4103
4104 By default SHOW/MUF will show the next two hours worth of data. You
4105 can specify anything up to 24 hours worth of data by appending the no of
4106 hours required after the prefix. For example:-
4107
4108 <tscreen><verb>
4109   SH/MUF W
4110 </verb></tscreen>
4111
4112 produces:
4113
4114 <tscreen><verb>
4115   RxSens: -123 dBM SFI: 159   R: 193   Month: 10   Day: 21
4116   Power :   20 dBW    Distance:  6283 km    Delay: 22.4 ms
4117   Location                       Lat / Long           Azim
4118   East Dereham, Norfolk          52 41 N 0 57 E         47
4119   United-States-W                43 0 N 87 54 W        299
4120   UT LT  MUF Zen  1.8  3.5  7.0 10.1 14.0 18.1 21.0 24.9 28.0 50.0
4121   18 23 11.5 -35  mS0+ mS2   S3
4122   19  0 11.2 -41  mS0+ mS2   S3
4123 </verb></tscreen>
4124
4125 indicating that you will have weak, fading circuits on top band and 
4126 80m but usable signals on 40m (about S3).
4127
4128 inputing:-
4129
4130 <tscreen><verb>
4131   SH/MUF W 24
4132 </verb></tscreen>
4133
4134 will get you the above display, but with the next 24 hours worth of
4135 propagation data.
4136
4137 <tscreen><verb>
4138   SH/MUF W L 24
4139   SH/MUF W 24 Long
4140 </verb></tscreen>
4141
4142 Gives you an estimate of the long path propagation characterics. It
4143 should be noted that the figures will probably not be very useful, nor
4144 terrible accurate, but it is included for completeness.
4145
4146 <sect1>show/node (1)
4147
4148 <P>
4149 <tt>
4150 <bf>show/node &lsqb;&lt;node_call&gt; ...&rsqb;</bf> Show the type and version
4151 number of nodes
4152 </tt>
4153
4154 <P>
4155 Show the type and version (if connected) of the nodes specified on the
4156 command line. If no callsigns are specified then a sorted list of all
4157 the non-user callsigns known to the system will be displayed.
4158
4159 <sect1>show/prefix (0)
4160
4161 <P>
4162 <tt>
4163 <bf>show/prefix &lt;callsign&gt;</bf> Interrogate the prefix database
4164 </tt>
4165
4166 <P>
4167 This command takes the &lt;callsign&gt; (which can be a full or partial 
4168 callsign or a prefix), looks up which internal country number 
4169 it is and then displays all the relevant prefixes for that country
4170 together with the internal country no, the CQ and ITU regions. 
4171
4172 See also SHOW/DXCC
4173
4174
4175 <sect1>show/program (5)
4176
4177 <P>
4178 <tt>
4179 <bf>show/program</bf> Show the locations of all the included program modules
4180 </tt>
4181
4182 <P>
4183 Show the name and location where every program module was load from. This
4184 is useful for checking where you think you have loaded a .pm file from.
4185
4186 <sect1>show/qra (0)
4187
4188 <P>
4189 <tt>
4190 <bf>show/qra &lt;locator&gt &lsqb;&lt;locator&gt;&rsqb;</bf> Show the distance
4191 between locators<newline>
4192 <bf>show/qra &lt;lat&gt; &lt;long&gt;</bf> Convert latitude and longitude to 
4193 a locator
4194 </tt>
4195
4196 <P>
4197 This is a multipurpose command that allows you either to calculate the
4198 distance and bearing between two locators or (if only one locator is
4199 given on the command line) the distance and beraing from your station
4200 to the locator. For example:-
4201
4202 <tscreen><verb>
4203 SH/QRA IO92QL 
4204 SH/QRA JN06 IN73
4205 </verb></tscreen>
4206
4207 The first example will show the distance and bearing to the locator from
4208 yourself, the second example will calculate the distance and bearing from
4209 the first locator to the second. You can use 4 or 6 character locators.
4210
4211 It is also possible to convert a latitude and longitude to a locator by 
4212 using this command with a latitude and longitude as an argument, for
4213 example:-
4214
4215 <tscreen><verb>
4216 SH/QRA 52 41 N 0 58 E
4217 </verb></tscreen>
4218
4219 <sect1>show/qrz (0)
4220
4221 <P>
4222 <tt>
4223 <bf>show/qrz &lt;callsign&gt;</bf> Show any callbook details on a callsign
4224 </tt>
4225
4226 <P>
4227 This command queries the QRZ callbook server on the internet
4228 and returns any information available for that callsign. This service
4229 is provided for users of this software by http://www.qrz.com 
4230
4231 <sect1>show/route (0)
4232
4233 <P>
4234 <tt>
4235 <bf>show/route &lt;callsign&gt;</bf> Show the route to &lt;callsign&gt;
4236 </tt>
4237
4238 <P>
4239 This command allows you to see to which node the callsigns specified are
4240 connected. It is a sort of inverse sh/config.
4241
4242 <tscreen><verb>
4243   sh/route n2tly
4244 </verb></tscreen>
4245
4246 <sect1>show/satellite (0)
4247
4248 <P>
4249 <tt>
4250 <bf>show/satellite &lt;name&gt; &lsqb;&lt;hours&gt; &lt;interval&gt;&rsqb;</bf>
4251 Show satellite tracking data
4252 </tt>
4253
4254 <P>
4255 Show the tracking data from your location to the satellite of your choice
4256 from now on for the next few hours.
4257
4258 If you use this command without a satellite name it will display a list
4259 of all the satellites known currently to the system. 
4260
4261 If you give a name then you can obtain tracking data of all the passes
4262 that start and finish 5 degrees below the horizon. As default it will
4263 give information for the next three hours for every five minute period.
4264
4265 You can alter the number of hours and the step size, within certain 
4266 limits. 
4267
4268 Each pass in a period is separated with a row of '-----' characters
4269
4270 So for example:-
4271
4272 <tscreen><verb>
4273 SH/SAT AO-10 
4274 SH/SAT FENGYUN1 12 2
4275 </verb></tscreen>
4276
4277 <sect1>show/sun (0)
4278
4279 <P>
4280 <tt>
4281 <bf>show/sun &lsqb;&lt;prefix&gt;&verbar;&lt;callsign&gt;&rsqb;</bf> Show
4282 sun rise and set times
4283 </tt>
4284
4285 <P>
4286 Show the sun rise and set times for a (list of) prefixes or callsigns, 
4287 together with the azimuth and elevation of the sun currently at those
4288 locations.
4289
4290 If you don't specify any prefixes or callsigns, it will show the times for
4291 your QTH (assuming you have set it with either SET/LOCATION or SET/QRA),
4292 together with the current azimuth and elevation.
4293
4294 If all else fails it will show the sunrise and set times for the node
4295 that you are connected to. 
4296
4297 For example:-
4298
4299 <tscreen><verb>
4300   SH/SUN
4301   SH/SUN G1TLH K9CW ZS
4302 </verb></tscreen>
4303
4304 <sect1>show/time (0)
4305
4306 <P>
4307 <tt>
4308 <bf>show/time &lsqb;&lt;prefix&gt;&verbar;&lt;callsign&gt;&rsqb;</bf> Show
4309 the local time
4310 </tt>
4311
4312 <P>
4313 If no prefixes or callsigns are given then this command returns the local
4314 time and UTC as the computer has it right now. If you give some prefixes
4315 then it will show UTC and UTC + the local offset (not including DST) at
4316 the prefixes or callsigns that you specify.
4317
4318 <sect1>show/wcy (0)
4319
4320 <P>
4321 <tt>
4322 <bf>show/wcy</bf> Show the last 10 WCY broadcasts<newline>
4323 <bf>show/wcy &lt;n&gt;</bf> Show the last &lt;n&gt; WCY broadcasts
4324 </tt>
4325
4326 <P>
4327 Display the most recent WCY information that has been received by the system
4328
4329 <sect1>show/wwv (0)
4330
4331 <P>
4332 <tt>
4333 <bf>show/wwv</bf> Show the last 10 WWV broadcasts<newline>
4334 <bf>show/wwv &lt;n&gt;</bf> Show the last &lt;n&gt; WWV broadcasts
4335 </tt>
4336
4337 <P>
4338 Display the most recent WWV information that has been received by the system
4339
4340
4341 <sect1>shutdown (5)
4342
4343 <P>
4344 <tt>
4345 <bf>shutdown</bf> Shutdown the cluster
4346 </tt>
4347
4348 <P>
4349 Shutdown the cluster and disconnect all the users.  If you have Spider
4350 set to respawn in /etc/inittab it will of course restart.
4351
4352 <sect1>spoof (9)
4353
4354 <P>
4355 <tt>
4356 <bf>spoof &lt;callsign&gt; &lt;command&gt;</bf> Run commands as another user
4357 </tt>
4358
4359 <P>
4360 This is a very simple yet powerful command for the sysop.  It allows you to
4361 issue commands as if you were a different user.  This is very useful for the
4362 kind of things that users seem to always get wrong.. like home_node for
4363 example.
4364
4365 <sect1>stat/db (5)
4366
4367 <P>
4368 <tt>
4369 <bf>stat/db &lt;dbname&gt;</bf> Show the status of a database
4370 </tt>
4371
4372 <P>
4373 Show the internal status of a database descriptor.
4374
4375 Depending on your privilege level you will see more or less information. 
4376 This command is unlikely to be of much use to anyone other than a sysop.
4377
4378 <sect1>stat/channel (5)
4379
4380 <P>
4381 <tt>
4382 <bf>stat/channel &lt;callsign&gt;</bf> Show the status of a channel on the cluster
4383 </tt>
4384
4385 <P>
4386 Show the internal status of the channel object either for the channel that 
4387 you are on or else for the callsign that you asked for.
4388
4389 Only the fields that are defined (in perl term) will be displayed.
4390
4391 <sect1>stat/msg (5)
4392
4393 <P>
4394 <tt>
4395 <bf>stat/msg &lt;msgno&gt;</bf> Show the status of a message
4396 </tt>
4397
4398 <P>
4399 This command shows the internal status of a message and includes information
4400 such as to whom it has been forwarded, its size, origin etc etc.
4401
4402 <sect1>stat/user (5)
4403
4404 <P>
4405 <tt>
4406 <bf>stat/user &lt;callsign&gt;</bf> Show the full status of a user
4407 </tt>
4408
4409 <P>
4410 Shows the full contents of a user record including all the secret flags
4411 and stuff.
4412
4413 Only the fields that are defined (in perl term) will be displayed.
4414
4415 <sect1>sysop (0)
4416
4417 <P>
4418 <tt>
4419 <bf>sysop</bf> Regain your privileges if you login remotely
4420 </tt>
4421
4422 <P>
4423 The system automatically reduces your privilege level to that of a
4424 normal user if you login in remotely. This command allows you to
4425 regain your normal privilege level. It uses the normal system: five
4426 numbers are returned that are indexes into the character array that is
4427 your assigned password (see SET/PASSWORD). The indexes start from
4428 zero.
4429
4430 You are expected to return a string which contains the characters
4431 required in the correct order. You may intersperse those characters
4432 with others to obscure your reply for any watchers. For example (and
4433 these values are for explanation :-):
4434
4435 <tscreen><verb>
4436   password = 012345678901234567890123456789
4437   > sysop
4438   22 10 15 17 3
4439 </verb></tscreen>
4440
4441 you type:-
4442
4443 <tscreen><verb>
4444  aa2bbbb0ccc5ddd7xxx3n
4445  or 2 0 5 7 3
4446  or 20573
4447 </verb></tscreen>
4448
4449 They will all match. If there is no password you will still be offered
4450 numbers but nothing will happen when you input a string. Any match is
4451 case sensitive.
4452
4453 <sect1>talk (0)
4454
4455 <P>
4456 <tt>
4457 <bf>talk &lt;callsign&gt;</bf> Enter talk mode with &lt;callsign&gt;<newline>
4458 <bf>talk &lt;callsign&gt; &lt;text&gt;</bf> Send a text message to &lt;callsign&gt;<newline>
4459 <bf>talk &lt;callsign&gt; &gt; &lt;node_call&gt; &lsqb;&lt;text&gt;&rsqb;</bf>
4460 Send a text message to &lt;callsign&gt; via &lt;node_call&gt;
4461 </tt>
4462
4463 <P>
4464 Send a short message to any other station that is visible on the cluster
4465 system. You can send it to anyone you can see with a SHOW/CONFIGURATION 
4466 command, they don't have to be connected locally.
4467
4468 The second form of TALK is used when other cluster nodes are connected
4469 with restricted information. This usually means that they don't send 
4470 the user information usually associated with logging on and off the cluster.
4471
4472 If you know that G3JNB is likely to be present on GB7TLH, but you can only
4473 see GB7TLH in the SH/C list but with no users, then you would use the
4474 second form of the talk message.
4475
4476 If you want to have a ragchew with someone you can leave the text message
4477 out and the system will go into 'Talk' mode. What this means is that a
4478 short message is sent to the recipient telling them that you are in a 'Talking' 
4479 frame of mind and then you just type - everything you send will go to the 
4480 station that you asked for. 
4481
4482 All the usual announcements, spots and so on will still come out on your
4483 terminal.
4484
4485 If you want to do something (such as send a spot) you precede the normal 
4486 command with a '/' character, eg:-
4487
4488 <tscreen><verb>
4489    /DX 14001 G1TLH What's a B class licensee doing on 20m CW?
4490    /HELP talk
4491 </verb></tscreen>
4492
4493 To leave talk mode type:
4494    
4495 <tscreen><verb>
4496    /EX
4497 </verb></tscreen>
4498
4499 <sect1>type (0)
4500
4501 <P>
4502 <tt>
4503 <bf>type &lt;filearea&gt;/&lt;name&gt;</bf> Look at a file in one of the fileareas
4504 </tt>
4505
4506 <P>
4507 Type out the contents of a file in a filearea. So, for example, in 
4508 filearea 'bulletins' you want to look at file 'arld051' you would 
4509 enter:-
4510
4511 <tscreen><verb>
4512    TYPE bulletins/arld051
4513 </verb></tscreen>
4514
4515 See also SHOW/FILES to see what fileareas are available and a 
4516 list of content.
4517
4518 <sect1>who (0)
4519
4520 <P>
4521 <tt>
4522 <bf>who</bf> Show who is physically connected locally
4523 </tt>
4524
4525 <P>
4526 This is a quick listing that shows which callsigns are connected and
4527 what sort of connection they have
4528
4529 <sect1>wx (0)
4530
4531 <P>
4532 <tt>
4533 <bf>wx &lt;text&gt;</bf> Send a weather message to local users<newline>
4534 <bf>wx full &lt;text&gt; </bf> Send a weather message to all cluster users
4535 </tt>
4536
4537 <P>
4538 Weather messages can sometimes be useful if you are experiencing an extreme
4539 that may indicate enhanced conditions
4540
4541 <sect1>wx (enhanced for sysops) (5)
4542
4543 <P>
4544 <tt>
4545 <bf>wx sysop &lt;text&gt;</bf> Send a weather message to other clusters only
4546 </tt>
4547
4548 <P>
4549 Send a weather message only to other cluster nodes and not to general users.
4550
4551
4552
4553 </article>