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