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