1 The DXSpider Administration Manual v1.48
2 Ian Maude, G0VGS, (ianmaude@btinternet.com)
3 Version 1.49 November 2001 revision 1.0
5 A reference for SysOps of the DXSpider DXCluster program.
6 ______________________________________________________________________
67 1. Routing and Filtering
71 1.3 The node_default filter
72 1.4 General route filtering
73 1.5 General filter rules
77 1.9 Advanced filtering
78 1.10 Basic hop control
79 1.11 Hop Control on Specific Nodes
80 1.12 Isolating networks
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
96 3.7 Distribution lists
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
109 6. Information, files and useful programs
114 6.4 Other text messages
117 6.7 Updating kepler data
128 9. The DXSpider command set
130 9.1 accept/announce (0)
131 9.2 accept/announce (extended for sysops) (8)
134 9.5 accept/spots (extended for sysops) (8)
136 9.7 accept/wcy (extended for sysops) (8)
138 9.9 accept/wwv (extended for sysops) (8)
140 9.11 announce full (0)
141 9.12 announce sysop (5)
154 9.25 directory (extended for sysops) (5)
158 9.29 export_users (9)
159 9.30 forward/latlong (8)
160 9.31 forward/opername (1)
167 9.38 load/aliases (9)
170 9.41 load/cmd_cache (9)
171 9.42 load/forward (9)
172 9.43 load/messages (9)
173 9.44 load/prefixes (9)
180 9.51 read (extended for sysops) (5)
182 9.53 reject/announce (extended for sysops) (8)
183 9.54 reject/route (8)
184 9.55 reject/spots (0)
185 9.56 reject/spots (extended for sysops) (8)
187 9.58 reject/wcy (extended for sysops) (8)
189 9.60 reject/wwv (extended for sysops) (8)
193 9.64 set/announce (0)
194 9.65 set/arcluster (5)
197 9.68 set/badspotter (8)
207 9.78 set/homenode (0)
210 9.81 set/language (0)
211 9.82 set/location (0)
212 9.83 set/sys_location (9)
213 9.84 set/logininfo (0)
217 9.88 set/obscount (9)
219 9.90 set/password (9)
220 9.91 set/pinginterval (9)
221 9.92 set/privilege (9)
231 9.102 show/badnode (6)
232 9.103 show/badspotter (1)
233 9.104 show/configuration (0)
234 9.105 show/configuration/node (0)
235 9.106 show/connect (1)
241 9.112 show/filter (0)
242 9.113 show/filter (extended for sysops) (5)
244 9.115 show/isolate (1)
245 9.116 show/lockout (9)
250 9.121 show/prefix (0)
251 9.122 show/program (5)
255 9.126 show/satellite (0)
263 9.134 stat/channel (5)
265 9.136 stat/route_node (5)
266 9.137 stat/route_user (5)
273 9.144 wx (enhanced for sysops) (5)
276 ______________________________________________________________________
278 1. Routing and Filtering
282 From DXSpider version 1.48, major changes were introduced to the way
283 node connections are treated. This is part of an ongoing process to
284 remove problems with loops and to enable talk and other functions to
285 propagate across the whole of the worldwide cluster network. In fact,
286 in a Spider network, it would be useful, perhaps even necessary to
287 have loops. This would give real resilience to the network, meaning
288 that if a link dropped, the information flow would simply come in and
289 go out via a different route. Of course, we do not have a complete
290 network of Spider nodes, there are other programs out there. Some of
291 these do not have any protection from loops. Certainly AK1A does not
292 handle loops well at all. It is therefore necessary to have some form
293 of protection for these nodes.
296 In fact DXSpider has had a simple system for some time which is called
297 isolation. This is similar to what in other systems such as clx, is
298 called passive mode. A more detailed explanation of isolation is given
299 further below. This system is still available and, for simple
300 networks, is probably all that you need.
303 The new functionality introduced in version 1.48 allows filtering the
304 node and user protocol frames on a "per interface" basis. We call this
305 route filtering. This is used instead of isolation.
308 What this really means is that you can control more or less completely
309 which user and node management PC protocol frames pass to each of your
310 partner nodes. You can also limit what comes into your node from your
311 partners. It is even possible to control the settings that your
312 partner node has for the routing information that it sends to you
313 (using the rcmd command).
318 Initially when route filters were being tested we generated a
319 "default" filter. Unfortunately it quickly became apparent that this
320 might suit the UK cluster network but didn't really fit anybody else.
321 However using a default filter is an appropriate thing to do. How, is
322 explained further on.
325 The first thing that you must do is determine whether you need to use
326 route filtering at all. If you are a "normal" node with two or three
327 partners and you arranged in an "official" non-looping tree type
328 network, then you do not need to do route filtering and you will feel
329 a lot better for not getting involved. If you are successfully using
330 isolation then you also probably don't need to use route filtering.
331 To put it simply, you should not mix Isolation and Route Filtering.
332 It will work, of sorts, but you will not get the expected results. If
333 you are using Isolation sucessfully at the moment, do not get involved
334 in Route Filtering unless you have a good supply of aspirin! Once you
335 have started down the road of Route Filtering, do not use Isolation
336 either. Use one or the other, not both.
339 You will only require this functionality if you are "well-connected".
340 What that means is that you are connected to several different parts
341 of (say) the EU cluster and, at the same time, also connected to two
342 or three places in the US which, in turn are connected back to the EU.
343 This is called a "loop" and if you are seriously looped then you need
347 I should at this stage give a little bit of background on filters.
348 All the filters in Spider work in basically the same way. You can
349 either accept or reject various options in order to create the filter
350 rules you wish to achieve. Some filters are user settable, others can
351 only be altered by the sysop. Route filtering can only be done by the
356 Anyway, without further discouragement, let me start the process of
360 1.3. The node_default filter
362 All normal systems should have a default routing filter and it should
363 usually be set to send only the normal, unlooped, view of your
364 "national" network. Here in the UK that means nodes from the UK and
365 Eire, in EU it is more complex as the networks there grew up in a more
370 The generic commands are:-
374 reject/route node_default <filter_option>
378 accept/route node_default <filter_option>
383 where filter_option is one of the following ...
392 channel_dxcc <numbers>
393 channel_itu <numbers>
394 channel_zone <numbers>
397 Please be careful if you alter this setting, it will affect ALL your
398 links! Remember, this is a default filter for node connections, not a
402 For the default routing filter then you have two real choices: either
403 a "national" view or the "safe" option of only your own callsign.
404 Examples of each (for my node: GB7DJK) are:-
408 acc/route node_default call_dxcc 61,38
409 acc/route node_default call gb7djk
414 GB7DJK uses the first of these. The DXCC countries can be obtained
415 from the show/prefix command.
418 The example filters shown control output TO all your partner nodes
419 unless they have a specific filter applied to them (see next section).
422 It is also possible to control the incoming routing information that
423 you are prepared to accept FROM your partner nodes. The reason this is
424 necessary is to make sure that stuff like mail, pings and similar
425 commands a) go down the correct links and b) don't loop around
426 excessively. Again using GB7DJK as an example a typical default input
427 filter would be something like:
431 rej/route node_default input call_dxcc 61,38 and not channel_dxcc 61,38
436 What this does is accept node and user information for our national
437 network from nodes that are in our national network, but rejects such
438 information from anyone else. Although it doesn't explicitly say so,
439 by implication, any other node information (not from the UK and Eire)
443 As I imagine it will take a little while to get one's head around all
444 of this you can study the effect of any rules that you try by watching
445 the debug output after having done:-
454 After you have got tired of that, to put it back the way it was:-
463 1.4. General route filtering
465 Exactly the same rules apply for general route filtering. You would
466 use either an accept filter or a reject filter like this ...
470 reject/route <node_call> <filter_option>
474 accept/route <node_call> <filter_option>
480 Here are some examples of route filters ...
484 rej/route gb7djk call_dxcc 61,38 (send everything except UK+EIRE nodes)
485 rej/route all (equiv to [very] restricted mode)
486 acc/route gb7djk call_dxcc 61,38 (send only UK+EIRE nodes)
487 acc/route gb7djk call gb7djk (equiv to SET/ISOLATE)
492 In practice you will either be opening the default filter out for a
493 partner by defining a specific filter for that callsign:-
498 acc/route gb7baa input all
503 or restricting it quite a lot, in fact making it very nearly like an
504 isolated node, like this:-
508 acc/route pi4ehv-8 call gb7djk
509 rej/route pi4ehv-8 input call_dxcc 61,38
514 This last example takes everything except UK and Eire from PI4EHV-8
515 but only sends him my local configuration (just a PC19 for GB7DJK and
516 PC16s for my local users).
519 It is possible to write much more complex rules, there are up to 10
520 accept/reject pairs per callsign per filter. For more information see
525 1.5. General filter rules
527 Upto v1.44 it was not possible for the user to set their own filters.
528 From v1.45 though that has all changed. It is now possible to set
529 filters for just about anything you wish. If you have just updated
530 from an older version of DXSpider you will need to update your new
531 filters. You do not need to do anything with your old filters, they
532 will be renamed as you update.
535 There are 3 basic commands involved in setting and manipulating
536 filters. These are accept, reject and clear. First we will look
537 generally at filtering. There are a number of things you can filter in
538 the DXSpider system. They all use the same general mechanism.
541 In general terms you can create a "reject" or an "accept" filter which
542 can have up to 10 lines in it. You do this using, for example ...
553 where ..... are the specific commands for that type of filter. There
554 are filters for spots, wwv, announce, wcy and (for sysops) connects.
555 See each different accept or reject command reference for more
558 There is also a command to clear out one or more lines in a filter.
569 There is clear/xxxx command for each type of filter.
572 and you can check that your filters have worked by the command ...
583 For now we are going to use spots for the examples, but you can apply
584 the same principles to all types of filter.
589 There are two main types of filter, accept or reject. You can use
590 either to achieve the result you want dependent on your own preference
591 and which is more simple to do. It is pointless writing 8 lines of
592 reject filters when 1 accept filter would do the same thing! Each
593 filter has 10 lines (of any length) which are tried in order. If a
594 line matches then the action you have specified is taken (ie reject
595 means ignore it and accept means take it)
598 If you specify reject filters, then any lines that arrive that match
599 the filter will be dumped but all else will be accepted. If you use
600 an accept filter, then ONLY the lines in the filter will be accepted
601 and all else will be dumped. For example if you have a single line
606 accept/spots on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
611 then you will ONLY get VHF spots from or to CQ zones 14, 15 and 16.
614 If you set a reject filter like this ...
618 reject/spots on hf/cw
623 Then you will get everything EXCEPT HF CW spots. You could make this
624 single filter even more flexible. For example, if you are interested
625 in IOTA and will work it even on CW even though normally you are not
626 interested in CW, then you could say ...
630 reject/spots on hf/cw and not info iota
635 But in that case you might only be interested in iota and say:-
639 accept/spots not on hf/cw or info iota
644 which achieves exactly the same thing. You should choose one or the
645 other until you are comfortable with the way it works. You can mix
646 them if you wish (actually you can have an accept AND a reject on the
647 same line) but don't attempt this until you are sure you know what you
651 You can arrange your filter lines into logical units, either for your
652 own understanding or simply convenience. Here is an example ...
656 reject/spots 1 on hf/cw
657 reject/spots 2 on 50000/1400000 not (by_zone 14,15,16 or call_zone 14,15,16)
661 What this does is to ignore all HF CW spots and also rejects any spots
662 on VHF which don't either originate or spot someone in Europe.
665 This is an example where you would use a line number (1 and 2 in this
666 case), if you leave the digit out, the system assumes '1'. Digits
667 '0'-'9' are available. This make it easier to see just what filters
668 you have set. It also makes it more simple to remove individual
669 filters, during a contest for example.
672 You will notice in the above example that the second line has
673 brackets. Look at the line logically. You can see there are 2
674 separate sections to it. We are saying reject spots that are VHF or
675 above APART from those in zones 14, 15 and 16 (either spotted there or
676 originated there). If you did not have the brackets to separate the 2
677 sections, then Spider would read it logically from the front and see a
678 different expression entirely ...
682 (on 50000/1400000 and by_zone 14,15,16) or call_zone 14,15,16
687 The simple way to remember this is, if you use OR - use brackets.
688 Whilst we are here CASE is not important. 'And BY_Zone' is just the
689 same as 'and by_zone'.
691 As mentioned earlier, setting several filters can be more flexible
692 than simply setting one complex one. Doing it in this way means that
693 if you want to alter your filter you can just redefine or remove one
694 or more lines of it or one line. For example ...
698 reject/spots 1 on hf/ssb
703 would redefine our earlier example, or
712 To remove all the filter lines in the spot filter ...
724 You can filter in several different ways. The options are listed in
725 the various helpfiles for accept, reject and filter.
729 Sometimes all that is needed is a general rule for node connects.
730 This can be done with a node_default filter. This rule will always be
731 followed, even if the link is isolated, unless another filter is set
732 specifically. Default rules can be set for nodes and users. They can
733 be set for spots, announces, WWV and WCY. They can also be used for
734 hops. An example might look like this ...
738 accept/spot node_default by_zone 14,15,16,20,33
739 set/hops node_default spot 50
744 This filter is for spots only, you could set others for announce, WWV
745 and WCY. This filter would work for ALL nodes unless a specific
746 filter is written to override it for a particular node. You can also
747 set a user_default should you require. It is important to note that
748 default filters should be considered to be "connected". By this I
749 mean that should you override the default filter for spots, you need
750 to add a rule for the hops for spots also.
753 1.9. Advanced filtering
755 Once you are happy with the results you get, you may like to
759 The previous example that filters hf/cw spots and accepts vhf/uhf
760 spots from EU can be written with a mixed filter, for example ...
766 acc/spot 2 on 50000/1400000 and (by_zone 14,15,16 or call_zone 14,15,16)
771 Note that the first filter has not been specified with a number. This
772 will automatically be assumed to be number 1. In this case, we have
773 said reject all HF spots in the CW section of the bands but accept all
774 others at HF. Also accept anything in VHF and above spotted in or by
775 operators in the zones 14, 15 and 16. Each filter slot actually has a
776 'reject' slot and an 'accept' slot. The reject slot is executed BEFORE
780 It was mentioned earlier that after a reject test that doesn't match,
781 the default for following tests is 'accept', the reverse is true for
782 'accept'. In the example what happens is that the reject is executed
783 first, any non hf/cw spot is passed to the accept line, which lets
784 through everything else on HF. The next filter line lets through just
785 VHF/UHF spots from EU.
788 1.10. Basic hop control
790 In /spider/data you will find a file called hop_table.pl. This is the
791 file that controls your hop count settings. It has a set of default
792 hops on the various PC frames and also a set for each node you want to
793 alter the hops for. You may be happy with the default settings of
794 course, but this powerful tool can help to protect and improve the
795 network. The file will look something like this ...
800 # hop table construction
805 # default hopcount to use
808 # some variable hop counts based on message type
819 # the per node hop control thingy
853 Each set of hops is contained within a pair of curly braces and
854 contains a series of PC frame types. PC11 for example is a DX spot.
855 The figures here are not exhaustive but should give you a good idea of
859 You can alter this file at any time, including whilst the cluster is
860 running. If you alter the file during runtime, the command load/hops
861 will bring your changes into effect.
864 1.11. Hop Control on Specific Nodes
866 You can set a callsign specific hop count for any of the standard
871 set/hops gb7djk spot 4
872 set/hops node_default route 10
873 set/hops gb7baa wcy 5
878 all work on their specific area of the protocol.
881 The set/hops command overrides any hops that you have set otherwise.
884 You can set what hops have been set using the show/hops command.
887 1.12. Isolating networks
889 It is possible to isolate networks from each other on a "gateway" node
890 using the set/isolate <node_call> command.
893 The effect of this is to partition an isolated network completely from
894 another node connected to your node. Your node will appear on and
895 otherwise behave normally on every network to which you are connected,
896 but data from an isolated network will not cross onto any other
897 network or vice versa. However all the spot, announce and WWV traffic
898 and personal messages will still be handled locally (because you are a
899 real node on all connected networks), that is locally connected users
900 will appear on all networks and will be able to access and receive
901 information from all networks transparently. All routed messages will
902 be sent as normal, so if a user on one network knows that you are a
903 gateway for another network, he can still still send a talk/announce
904 etc message via your node and it will be routed across.
907 If you use isolate on a node connection you will continue to receive
908 all information from the isolated partner, however you will not pass
909 any information back to the isolated node. There are times when you
910 would like to forward only spots across a link (maybe during a contest
911 for example). To do this, isolate the node in the normal way and use
912 an acc/spot >call< all filter to override the isolate.
919 In the /spider/msg directory you will find a file called
920 badmsg.pl.issue. Rename this to badmsg.pl and edit the file. The
921 original looks something like this ....
925 # the list of regexes for messages that we won't store having
926 # received them (bear in mind that we must receive them fully before
930 # The format of each line is as follows
932 # type source pattern
933 # P/B/F T/F/O/S regex
935 # type: P - private, B - bulletin (msg), F - file (ak1a bull)
936 # source: T - to field, F - from field, O - origin, S - subject
937 # pattern: a perl regex on the field requested
939 # Currently only type B and P msgs are affected by this code.
941 # The list is read from the top down, the first pattern that matches
942 # causes the action to be taken.
944 # The pattern can be undef or 0 in which case it will always be selected
945 # for the action specified
958 I think this is fairly self explanatory. It is simply a list of
959 subject headers that we do not want to pass on to either the users of
960 the cluster or the other cluster nodes that we are linked to. This is
961 usually because of rules and regulations pertaining to items for sale
962 etc in a particular country.
966 2.2. Filtering words from text fields in Announce, Talk and DX spots
968 From version 1.48 onwards the interface to this has changed. You can
969 now use the commands set/badword to add words that you are not
970 prepared to see on the cluster, unset/badword to allow that word again
971 and show/badword to list the words that you have set.
974 If you have a previous /spider/data/badwords, the first time you start
975 the node, it will read and convert this file to the new commands. The
976 old style file will then be removed.
979 2.3. Stopping (possibly bad) DX Spots from Nodes or Spotters
982 There are a number of commands that control whether a spot progresses
983 any further by regarding it as "bad" in some way.
986 A DX Spot has a number of fields which can be checked to see whether
987 they contain "bad" values, they are: the DX callsign itself, the
988 Spotter and the Originating Node.
991 There are a set of commands which allow the sysop to control whether a
1003 These work in the same as the set/badword command, you can add any
1004 words or callsigns or whatever to the appropriate database. For
1005 example, to stop a spot from a particular node you do:
1009 set/badnode gb7djk gb7dxc
1018 set/badspotter b0mb p1rat nocall
1027 set/baddx video wsjt
1032 You can remove a word using the appropriate unset command
1033 (unset/baddx, unset/badspotter, unset/badnode) or list them using one
1034 of show/baddx, show/badspotter and show/badnode.
1039 DXSpider deals seamlessly with standard AK1A type mail. It supports
1040 both personal and bulletin mail and the sysop has additional commands
1041 to ensure that mail gets to where it is meant. DXSpider will send
1042 mail almost immediately, assuming that the target is on line.
1043 However, only one mail message is dealt with at any one time. If a
1044 mail message is already being sent or recieved, then the new message
1045 will be queued until it has finished.
1047 The cluster mail is automatically deleted after 30 days unless the
1048 sysop sets the "keep" flag using the msg command.
1053 Personal mail is sent using the sp command. This is actually the
1054 default method of sending mail and so a simple s for send will do. A
1055 full list of the send commands and options is in the command set
1056 section, so I will not duplicate them here.
1059 Bulletin mail is sent by using the sb command. This is one of the
1060 most common mistakes users make when sending mail. They send a
1061 bulletin mail with s or sp instead of sb and of course the message
1062 never leaves the cluster. This can be rectified by the sysop by using
1066 Bulletin addresses can be set using the Forward.pl file.
1071 DXSpider receives all and any mail sent to it without any alterations
1072 needed in files. Because personal and bulletin mail are treated
1073 differently, there is no need for a list of accepted bulletin
1074 addresses. It is necessary, however, to tell the program which links
1075 accept which bulletins. For example, it is pointless sending
1076 bulletins addresses to "UK" to any links other than UK ones. The file
1077 that does this is called forward.pl and lives in /spider/msg. At
1078 default, like other spider files it is named forward.pl.issue. Rename
1079 it to forward.pl and edit the file to match your requirements. The
1085 # this is an example message forwarding file for the system
1087 # The format of each line is as follows
1089 # type to/from/at pattern action destinations
1090 # P/B/F T/F/A regex I/F [ call [, call ...] ]
1092 # type: P - private, B - bulletin (msg), F - file (ak1a bull)
1093 # to/from/at: T - to field, F - from field, A - home bbs, O - origin
1094 # pattern: a perl regex on the field requested
1095 # action: I - ignore, F - forward
1096 # destinations: a reference to an array containing node callsigns
1098 # if it is non-private and isn't in here then it won't get forwarded
1100 # Currently only type B msgs are affected by this code.
1102 # The list is read from the top down, the first pattern that matches
1103 # causes the action to be taken.
1105 # The pattern can be undef or 0 in which case it will always be selected
1106 # for the action specified
1108 # If the BBS list is undef or 0 and the action is 'F' (and it matches the
1109 # pattern) then it will always be forwarded to every node that doesn't have
1110 # it (I strongly recommend you don't use this unless you REALLY mean it, if
1111 # you allow a new link with this on EVERY bull will be forwarded immediately
1112 # on first connection)
1123 Simply insert a bulletin address and state in the brackets where you
1124 wish that mail to go. For example, you can see here that mail sent to
1125 "UK" will only be sent to the UK links and not to PA4AB-14.
1128 To force the cluster to reread the file use load/forward
1132 3.4. The msg command
1134 The msg command is a very powerful and flexible tool for the sysop.
1135 It allows the sysop to alter to and from fields and make other changes
1136 to manage the cluster mail.
1138 Here is a full list of the various options ...
1142 MSG TO <msgno> <call> - change TO callsign to <call>
1143 MSG FRom <msgno> <call> - change FROM callsign to <call>
1144 MSG PRrivate <msgno> - set private flag
1145 MSG NOPRrivate <msgno> - unset private flag
1146 MSG RR <msgno> - set RR flag
1147 MSG NORR <msgno> - unset RR flag
1148 MSG KEep <msgno> - set the keep flag (message won't be deleted ever)
1149 MSG NOKEep <msgno> - unset the keep flag
1150 MSG SUbject <msgno> <new> - change the subject to <new>
1151 MSG WAittime <msgno> - remove any waiting time for this message
1152 MSG NOREad <msgno> - mark message as unread
1153 MSG REad <msgno> - mark message as read
1154 MSG QUeue - queue any outstanding bulletins
1155 MSG QUeue 1 - queue any outstanding private messages
1160 These commands are simply typed from within the cluster as the sysop
1166 You can check on a message from within the cluster by using the
1167 command stat/msg. This will give you additional information on the
1168 message number including which nodes have received it, which node it
1169 was received from and when etc. Here is an example of the output of
1174 G0VGS de GB7MBC 28-Jan-2001 1308Z >
1177 Msg Time: 26-Jan-2001 1302Z
1181 Subject: AMSAT 2line KEPS 01025.AMSAT
1183 Got it Nodes: GB7BAA, GB7ADX
1187 G0VGS de GB7MBC 28-Jan-2001 1308Z >
1191 This is described in the section on Other filters so I will not
1195 3.7. Distribution lists
1197 Distribution lists are simply a list of users to send certain types of
1198 mail to. An example of this is mail you only wish to send to other
1199 sysops. In /spider/msg there is a directory called distro. You put
1200 any distibution lists in here. For example, here is a file called
1201 SYSOP.pl that caters for the UK sysops.
1205 qw(GB7TLH GB7DJK GB7DXM GB7CDX GB7BPQ GB7DXN GB7MBC GB7MBC-6 GB7MDX
1206 GB7NDX GB7SDX GB7TDX GB7UDX GB7YDX GB7ADX GB7BAA GB7DXA GB7DXH
1207 GB7DXK GB7DXI GB7DXS)
1212 Any mail sent to "sysop" would only be sent to the callsigns in this
1218 Spider provides a simple BBS interface. No input is required from the
1219 sysop of the cluster at all. The BBS simply sets the cluster as a BBS
1220 and pushes any required mail to the cluster. No mail can flow from
1221 Spider to the BBS, the interface is one-way.
1224 Please be careful not to flood the cluster network with unnecessary
1225 mail. Make sure you only send mail to the clusters that want it by
1226 using the Forward.pl file very carefully.
1231 From 1.48 onwards it will become increasingly possible to control
1232 DXSpider's operation with scripts of various kinds.
1235 In the first instance, in 1.48, the sysop can create, with their
1236 favorite text editor, files in the directory /spider/scripts which
1237 contain any legal command for a callsign or class of connection which
1238 will be executed at logon.
1242 The filename is the callsign of the connection that you want the
1243 script to operate on, eg: /spider/scripts/g1tlh. The filenames are
1244 always in lower case on those architectures where this makes a
1248 In addition to the callsign specific scripts there are three others:-
1262 The startup script is executed immediately after all initialisation of
1263 the node is done, but before any connections are possible.
1266 The user_default script is executed for every user that does NOT
1267 already have a specific script.
1270 The node_default script is executed for every node that doesn't have a
1274 There are a couple of examples in the /spider/scripts directory.
1279 Spider allows the creation of local or remote databases. It supports
1280 chained databases, allowing several different databases to be scanned
1281 with one simple command. Importing of databases is limited at present
1282 to the standard AK1A databases such as OBLAST and the DB0SDX QSL
1283 database but will expand with time.
1286 5.1. Creating databases
1288 Creating a database could not be more simple. All the commands are
1289 sent from the cluster prompt as the sysop user.
1291 To create a database you use the command dbcreate. It can be used in
1292 3 different ways like so ..
1301 To simply create a database locally, you just tell the command the
1302 name of the database. This does not create the actual database, it
1303 simply defines it to say that it exists.
1307 dbcreate <name> chain <name> [<name>...]
1312 This creates a chained database entry. The first database will be
1313 scanned, then the second, the third etc...
1317 dbcreate <name> remote <name>
1321 This creates a remote entry. the first name field is the database
1322 name at the remote node, then the remote switch, then the actual
1323 node_call of the remote node, for example...
1327 dbcreate buckmaster remote gb7dxc
1332 Remote databases cannot be chained, however, the last database in a
1333 chain can be a remote database.
1336 5.2. Importing databases
1338 The only databases that Spider can currently import are the standard
1339 AK1A databases such as OBLAST or the DB0SDX qsl and address database.
1340 This will be added to with time.
1342 To import such a database, first put the file somewhere useful like
1343 /tmp and then issue the following command ...
1347 dbimport oblast /tmp/OBLAST.FUL
1352 This will update the existing local oblast database or create it if it
1356 5.3. Checking available databases
1358 Once a database is created, you will want to check that it has been
1359 added. To do this use the dbavail command. This will output the
1360 available databases. For example ...
1365 DB Name Location Chain
1369 G0VGS de GB7MBC 3-Feb-2001 1925Z >
1375 5.4. Looking up databases
1377 To look for information in a defined database, simply use the dbshow
1378 command, for example ...
1382 dbshow buckmaster G0YLM
1387 will show the information for the callsign G0YLM from the buckmaster
1388 database if it exists. To make things more standard for the users you
1389 can add an entry in the Aliases file so that it looks like a standard
1390 show command like this ...
1398 Now you can simply use show/buckmaster or an abreviation.
1401 5.5. Removing databases
1403 To delete an existing database you use the dbremove command. For
1413 would remove the oblast database and its associated datafile from the
1414 system. There are no warnings or recovery possible from this command.
1415 If you remove a database it ceases to exist and would have to be
1416 created from scratch if you still required it.
1419 6. Information, files and useful programs
1423 One of the more important things a cluster sysop needs to do is to get
1424 information to his users. The simplest way to do this is to have a
1425 banner that is sent to the user on login. This is know as a "message
1426 of the day" or "motd". To set this up, simply create a file in
1427 /spider/data called motd and edit it to say whatever you want. It is
1428 purely a text file and will be sent automatically to anyone logging in
1434 This message of the day file lives in the same directory as the
1435 standard motd file but is only sent to non-registered users. Once
1436 registered they will receive the same message as any other user.
1439 6.3. Downtime message
1441 If for any reason the cluster is down, maybe for upgrade or
1442 maintenance but the machine is still running, a message can be sent to
1443 the user advising them of the fact. This message lives in the
1444 /spider/data directory and is called "offline". Simply create the
1445 file and edit it to say whatever you wish. This file will be sent to
1446 a user attempting to log into the cluster when DXSpider is not
1453 6.4. Other text messages
1455 You can set other text messages to be read by the user if they input
1456 the file name. This could be for news items or maybe information for
1457 new users. To set this up, make a directory under /spider called
1458 packclus. Under this directory you can create files called news or
1459 newuser for example. In fact you can create files with any names you
1460 like. These can be listed by the user with the command ....
1469 They can be read by the user by typing the command ....
1478 If the file they want to read is called news. You could also set an
1479 alias for this in the Alias file to allow them just to type news
1482 You can also store other information in this directory, either
1483 directly or nested under directories. One use for this would be to
1484 store DX bulletins such as the OPDX bulletins. These can be listed
1485 and read by the user. To keep things tidy, make a directory under
1486 /spider/packclus called bulletin. Now copy any OPDX or similar
1487 bulletins into it. These can be listed by the user in the same way as
1488 above using the show/files command with an extension for the bulletin
1489 directory you have just created, like this ....
1499 An example would look like this ....
1504 bulletin DIR 20-Dec-1999 1715Z news 1602 14-Dec-1999 1330Z
1509 You can see that in the files area (basically the packclus directory)
1510 there is a file called news and a directory called bulletin. You can
1511 also see that dates they were created. In the case of the file news,
1512 you can also see the time it was last modified, a good clue as to
1513 whether the file has been updated since you last read it. To read the
1514 file called news you would simply issue the command ....
1524 To look what is in the bulletin directory you issue the command ....
1529 opdx390 21381 29-Nov-1999 1621Z opdx390.1 1670 29-Nov-1999 1621Z
1530 opdx390.2 2193 29-Nov-1999 1621Z opdx391 25045 29-Nov-1999 1621Z
1531 opdx392 35969 29-Nov-1999 1621Z opdx393 15023 29-Nov-1999 1621Z
1532 opdx394 33429 29-Nov-1999 1621Z opdx394.1 3116 29-Nov-1999 1621Z
1533 opdx395 24319 29-Nov-1999 1621Z opdx396 32647 29-Nov-1999 1621Z
1534 opdx396.1 5537 29-Nov-1999 1621Z opdx396.2 6242 29-Nov-1999 1621Z
1535 opdx397 18433 29-Nov-1999 1621Z opdx398 19961 29-Nov-1999 1621Z
1536 opdx399 17719 29-Nov-1999 1621Z opdx400 19600 29-Nov-1999 1621Z
1537 opdx401 27738 29-Nov-1999 1621Z opdx402 18698 29-Nov-1999 1621Z
1538 opdx403 24994 29-Nov-1999 1621Z opdx404 15685 29-Nov-1999 1621Z
1539 opdx405 13984 29-Nov-1999 1621Z opdx405.1 4166 29-Nov-1999 1621Z
1540 opdx406 28934 29-Nov-1999 1621Z opdx407 24153 29-Nov-1999 1621Z
1541 opdx408 15081 29-Nov-1999 1621Z opdx409 23234 29-Nov-1999 1621Z
1542 Press Enter to continue, A to abort (16 lines) >
1547 You can now read any file in this directory using the type command,
1552 type bulletin/opdx391
1553 Ohio/Penn DX Bulletin No. 391
1554 The Ohio/Penn Dx PacketCluster
1558 Editor Tedd Mirgliotta, KB8NW
1559 Provided by BARF-80 BBS Cleveland, Ohio
1560 Online at 440-237-8208 28.8k-1200 Baud 8/N/1 (New Area Code!)
1561 Thanks to the Northern Ohio Amateur Radio Society, Northern Ohio DX
1562 Association, Ohio/Penn PacketCluster Network, K1XN & Golist, WB2RAJ/WB2YQH
1563 & The 59(9) DXReport, W3UR & The Daily DX, K3TEJ, KN4UG, W4DC, NC6J, N6HR,
1564 Press Enter to continue, A to abort (508 lines) >
1569 The page length will of course depend on what you have it set to!
1572 6.5. The Aliases file
1574 You will find a file in /spider/cmd/ called Aliases. First, copy this
1575 file to /spider/local_cmd/Aliases and edit this file. You will see
1576 something like this ...
1587 # provide some standard aliases for commands for terminally
1588 # helpless ak1a user (helpless in the sense that they never
1589 # read nor understand help files)
1591 # This file is automagically reloaded if its modification time is
1592 # later than the one stored in CmdAlias.pm
1594 # PLEASE make this file consistant with reality! (the patterns MUST
1595 # match the filenames!)
1597 # Don't alter this file, copy it into the local_cmd tree and modify it.
1598 # This file will be replaced everytime I issue a new release.
1600 # You only need to put aliases in here for commands that don't work as
1601 # you desire naturally, e.g sh/dx on its own just works as you expect
1602 # so you need not add it as an alias.
1610 '^\?', 'apropos', 'apropos',
1613 '^ann.*/full', 'announce full', 'announce',
1614 '^ann.*/sysop', 'announce sysop', 'announce',
1615 '^ann.*/(.*)$', 'announce $1', 'announce',
1622 '^del', 'kill', 'kill',
1623 '^del\w*/fu', 'kill full', 'kill',
1624 '^di\w*/a\w*', 'directory all', 'directory',
1625 '^di\w*/b\w*', 'directory bulletins', 'directory',
1626 '^di\w*/n\w*', 'directory new', 'directory',
1627 '^di\w*/o\w*', 'directory own', 'directory',
1628 '^di\w*/s\w*', 'directory subject', 'directory',
1629 '^di\w*/t\w*', 'directory to', 'directory',
1630 '^di\w*/f\w*', 'directory from', 'directory',
1631 '^di\w*/(\d+)', 'directory $1', 'directory',
1648 '^l$', 'directory', 'directory',
1649 '^ll$', 'directory', 'directory',
1650 '^ll/(\d+)', 'directory $1', 'directory',
1655 '^news', 'type news', 'type',
1665 '^r$', 'read', 'read',
1666 '^rcmd/(\S+)', 'rcmd $1', 'rcmd',
1669 '^s/p$', 'send', 'send',
1670 '^sb$', 'send noprivate', 'send',
1671 '^set/home$', 'set/homenode', 'set/homenode',
1672 '^set/nobe', 'unset/beep', 'unset/beep',
1673 '^set/nohe', 'unset/here', 'unset/here',
1674 '^set/noan', 'unset/announce', 'unset/announce',
1675 '^set/nodx', 'unset/dx', 'unset/dx',
1676 '^set/nota', 'unset/talk', 'unset/talk',
1677 '^set/noww', 'unset/wwv', 'unset/wwv',
1678 '^set/nowx', 'unset/wx', 'unset/wx',
1679 '^sh$', 'show', 'show',
1680 '^sh\w*/buck', 'dbshow buck', 'dbshow',
1681 '^sh\w*/bu', 'show/files bulletins', 'show/files',
1682 '^sh\w*/c/n', 'show/configuration nodes', 'show/configuration',
1683 '^sh\w*/c$', 'show/configuration', 'show/configuration',
1684 '^sh\w*/com', 'dbavail', 'dbavail',
1685 '^sh\w*/dx/(\d+)-(\d+)', 'show/dx $1-$2', 'show/dx',
1686 '^sh\w*/dx/(\d+)', 'show/dx $1', 'show/dx',
1687 '^sh\w*/dx/d(\d+)', 'show/dx from $1', 'show/dx',
1688 '^sh\w*/email', 'dbshow email', 'dbshow',
1689 '^sh\w*/hftest', 'dbshow hftest', 'dbshow',
1690 '^sh\w*/vhftest', 'dbshow vhftest', 'dbshow',
1691 '^sh\w*/qsl', 'dbshow qsl', 'dbshow',
1692 '^sh\w*/tnc', 'who', 'who',
1693 '^sh\w*/up', 'show/cluster', 'show/cluster',
1694 '^sh\w*/w\w*/(\d+)-(\d+)', 'show/wwv $1-$2', 'show/wwv',
1695 '^sh\w*/w\w*/(\d+)', 'show/wwv $1', 'show/wwv',
1696 '^sp$', 'send', 'send',
1700 '^ta$', 'talk', 'talk',
1701 '^t$', 'talk', 'talk',
1708 '^wx/full', 'wx full', 'wx',
1709 '^wx/sysop', 'wx sysop', 'wx',
1722 You can create aliases for commands at will. Beware though, these may
1723 not always turn out as you think. Care is needed and you need to test
1724 the results once you have set an alias.
1729 In later versions of Spider a simple console program is provided for
1730 the sysop. This has a type ahead buffer with line editing facilities
1731 and colour for spots, announces etc. To use this program, simply use
1732 console.pl instead of client.
1735 To edit the colours, copy /spider/perl/Console.pl to /spider/local and
1736 edit the file with your favourite editor.
1739 6.7. Updating kepler data
1741 Spider has a powerful and flexible show/satellite command. In order
1742 for this to be accurate, the kepler data has to be updated regularly.
1743 In general, this data is available as an email or via cluster mail.
1744 Updating it is simple. First you need to export the mail message as a
1745 file. You do this with the export command from the cluster prompt as
1746 the sysop. For example ...
1750 export 5467 /spider/perl/keps.in
1755 would export message number 5467 as a file called keps.in in the
1756 /spider/perl directory.
1758 Now login to a VT as sysop and cd /spider/perl. There is a command in
1759 the perl directory called convkeps.pl. All we need to do now is
1760 convert the file like so ...
1764 ./convkeps.pl keps.in
1769 Now go back to the cluster and issue the command ...
1778 That is it! the kepler data has been updated.
1783 6.8. The QRZ callbook
1785 The command sh/qrz will only work once you have followed a few simple
1786 steps. First you need to get a user ID and password from qrz.com.
1787 Simply go to the site and create one. Secondly you need to copy the
1788 file /spider/perl/Internet.pm to /spider/local and alter it to match
1789 your user ID and password. You also at this point need to set
1790 $allow=1 to complete the setup. Many thanks to Fred Lloyd, the
1791 proprieter of qrz.com for allowing this access.
1796 The directory /spider/scripts is used for several things. Firstly it
1797 contains a file called startup that can be used to call in any changes
1798 to the cluster from the default settings on startup. Examples of this
1799 include how many spots it is possible to get with the sh/dx command,
1800 whether you want registration/passwords to be permanently on etc. An
1801 example file is shown below and is included in the distribution as
1807 # startup script example
1809 # set maximum no of spots allowed to 100
1810 # set/var $Spot::maxspots = 1
1812 # Set registration on
1813 # set/var $main::reqreg = 1
1816 # set/var $main::passwdreq = 1
1822 Secondly, it is used to store the login scripts for users. Currently
1823 this can only be done by the sysop but it is envisaged that eventually
1824 users will be able to set their own. An example is included in the
1825 distibution but here is a further example.
1843 The lines in between commands can simply insert a blank line or a
1844 character such as a + sign to make the output easier to read.
1851 From version 1.49 DXSpider has some additional security features.
1852 These are not by any means meant to be exhaustive, however they do
1853 afford some security against piracy. These two new features can be
1854 used independently of each other or in concert to tighten the
1860 The basic principle of registration is simple. If a user is not
1861 registered by the sysop, then they have read-only access to the
1862 cluster. The only thing they can actually send is a talk or a message
1863 to the sysop. In order for them to be able to spot, send announces or
1864 talks etc the sysop must register them with the set/register command,
1874 The user g0vgs can now fully use the cluster. In order to enable
1875 registration, you can issue the command ...
1879 set/var $main::reqreg = 1
1884 Any users that are not registered will now see the motd_nor file
1885 rather than the motd file as discussed in the Information, files and
1886 useful programs section.
1889 Entering this line at the prompt will only last for the time the
1890 cluster is running of course and would not be present on a restart.
1891 To make the change permanent, add the above line to
1892 /spider/scripts/startup. To read more on the startup file, see the
1893 section on Information, files and useful programs.
1896 To unregister a user use unset/register and to show the list of
1897 registered users, use the command show/register.
1902 At the moment, passwords only affect users who login to a DXSpider
1903 cluster node via telnet. If a user requires a password, they can
1904 either set it themselves or have the sysop enter it for them by using
1905 the set/password command. Any users who already have passwords, such
1906 as remote sysops, will be asked for their passwords automatically by
1907 the cluster. Using passwords in this way means that the user has a
1908 choice on whether to have a password or not. To force the use of
1909 passwords at login, issue the command ...
1913 set/var $main::passwdreq = 1
1915 at the cluster prompt. This can also be added to the
1916 /spider/scripts/startup file as above to make the change permanent.
1919 Of course, if you do this you will have to assign a password for each
1920 of your users. If you were asking them to register, it is anticipated
1921 that you would ask them to send you a message both to ask to be
1922 registered and to give you the password they wish to use.
1925 Should a user forget their password, it can be reset by the sysop by
1926 first removing the existing password and then setting a new one like
1931 unset/password g0vgs
1932 set/password g0vgs new_password
1940 CVS stands for "Concurrent Versions System" and the CVS for DXSpider
1941 is held at Sourceforge. This means that it is possible to update your
1942 DXSpider installation to the latest sources by using a few simple
1946 Please be aware that if you update your system using CVS, it is
1947 possible that you could be running code that is very beta and not
1948 fully tested. There is a possibility that it could be unstable.
1951 I am of course assuming that you have a machine with both DXSpider and
1952 Internet access running.
1955 BEFORE YOU EVEN CONSIDER STARTING WITH THIS MAKE A BACKUP OF YOUR
1956 ENTIRE SPIDER TREE!!
1959 Assuming you are connected to the Internet, you need to login to the
1960 CVS repository and then update your Spider source. There are several
1961 steps which are listed below ...
1964 First login as the user sysop. Next you need to connect to the CVS
1965 repository. You do this with the command below ...
1968 cvs -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login
1972 You will get a password prompt. Simply hit return here and your
1973 machine should return to a normal linux prompt.
1976 What happens next depends on whether you have an existing installation
1977 that you want to update with the latest and greatest or whether you
1978 just want to see what is there and/or run it on a new machine for
1981 If you are installing Spider from CVS then change directory to
1984 If you are wanting to update Spider then cd to /tmp
1987 The next step will create a brand new 'spider' directory in your
1991 cvs -z3 -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider co spider
1995 This command is all on one line.
1998 Hopefully your screen should show you downloading files. The -z3
1999 simply compresses the download to improve speed. When this has
2000 finished, you will have exactly the same as if you had untarred a full
2001 tarball PLUS some extra directories and files that CVS needs to do the
2005 Now if you are doing a new installation, that's it. Carry on as if
2006 you have just downloaded and untarred the lastest tarball.
2009 If you want to upgrade your current installation then do this ...
2013 tar cvfz /tmp/s.tgz spider
2015 tar xvfzp /tmp/s.tgz
2020 This is assuming you downloaded to the /tmp directory of course.
2023 NOTE: the 'p' on the end of the 'xvfz' is IMPORTANT! It keeps the
2024 permissions correct. YOU WERE LOGGED IN AS THE USER SYSOP WEREN'T
2027 Remember to recompile the C client (cd /spider/src; make)
2030 At this point the files have been upgraded. You can (usually) restart
2031 the cluster in your own time. However, if you attempt to use any new
2032 commands or features expect it to be fatal! At least your cluster
2033 will have been restarted then so it will be too late to worry about
2037 Now the magic part! From now on when you want to update, simply
2038 connect to the Internet and then, as the user sysop ...
2047 and your files will be updated. As above, remember to recompile the
2048 "C" client if it has been updated (CVS will tell you) and restart if
2049 any of the perl scripts have been altered or added, again, CVS will
2053 You will find any changes documented in the /spider/Changes file.
2056 9. The DXSpider command set
2058 Below is a complete list of commands available from the cluster
2059 prompt. Most maintenance tasks are automatic but there are some
2060 commands that are useful for a sysop. These are listed below in
2061 alphabetical order. The number in brackets following the command name
2062 is the permissions level needed to use the command.
2065 9.1. accept/announce (0)
2067 accept/announce [0-9] <pattern> Set an accept filter line for announce
2070 Create an 'accept this announce' line for a filter.
2072 An accept filter line means that if the announce matches this filter
2073 it is passed onto the user. See HELP FILTERS for more info. Please
2074 read this to understand how filters work - it will save a lot of grief
2077 You can use any of the following things in this line:-
2081 info <string> eg: iota or qsl
2082 by <prefixes> eg: G,M,2
2084 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
2085 origin_itu <numbers>
2086 origin_zone <numbers>
2091 wx 1 filter WX announces
2092 dest <prefixes> eg: 6MUK,WDX (distros)
2102 acc/ann 2 by_zone 14,15,16
2103 (this could be all on one line: acc/ann dest 6MUK or by_zone 14,15,16)
2118 This filter would only allow announces that were posted buy UK
2119 stations. You can use the tag 'all' to accept everything eg:
2128 but this probably for advanced users...
2131 9.2. accept/announce (extended for sysops) (8)
2133 accept/announce <call> [input] [0-9]<pattern> Announce filter sysop
2137 This version allows a sysop to set a filter for a callsign as well as
2138 the default for nodes and users eg:-
2143 accept/ann input node_default by G,M,2
2144 accept/ann user_default by G,M,2
2150 9.3. accept/route (8)
2152 accept/route <call> [0-9] <pattern> Set an 'accept' filter line for
2156 Create an 'accept this routing PC Protocol' line for a filter.
2159 An accept filter line means that if a PC16/17/19/21/24/41/50 matches
2160 this filter it is passed thru that interface. See HELP FILTERING for
2161 more info. Please read this to understand how filters work - it will
2162 save a lot of grief later on.
2165 You can use any of the following things in this line:-
2169 call <prefixes> the callsign of the thingy
2170 call_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
2173 origin <prefixes> really the interface it came in on
2174 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
2175 origin_itu <numbers>
2176 origin_zone <numbers>
2183 acc/route gb7djk call_dxcc 61,38 (send only UK+EIRE nodes)
2184 acc/route gb7djk call gb7djk (equiv to SET/ISOLATE)
2190 You can use the tag 'all' to accept everything eg:
2200 9.4. accept/spots (0)
2202 accept/announce [0-9] <pattern> Set an accept filter line for spots
2205 Create an 'accept this spot' line for a filter.
2208 An accept filter line means that if the spot matches this filter it is
2209 passed onto the user. See HELP FILTERS for more info. Please read this
2210 to understand how filters work - it will save a lot of grief later on.
2212 You can use any of the following things in this line:-
2216 freq <range> eg: 0/30000 or hf or hf/cw or 6m,4m,2m
2217 on <range> same as 'freq'
2218 call <prefixes> eg: G,PA,HB9
2219 info <string> eg: iota or qsl
2221 call_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
2234 For frequencies, you can use any of the band names defined in
2235 SHOW/BANDS and you can use a subband name like: cw, rtty, data, ssb -
2236 thus: hf/ssb. You can also just have a simple range like: 0/30000 -
2237 this is more efficient than saying simply: freq HF (but don't get too
2246 acc/spot 2 on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
2251 You can use the tag 'all' to accept everything, eg:
2260 but this probably for advanced users...
2263 9.5. accept/spots (extended for sysops) (8)
2265 accept/spots <call> [input] [0-9] <pattern> Spot filter sysop version
2268 This version allows a sysop to set a filter for a callsign as well as
2269 the default for nodes and users eg:-
2273 accept/spot db0sue-7 1 by_zone 14,15,16
2274 accept/spot node_default all
2275 set/hops node_default 10
2277 accept/spot user_default by G,M,2
2285 accept/wcy [0-9] <pattern> set an accept WCY filter
2288 It is unlikely that you will want to do this, but if you do then you
2289 can filter on the following fields:-
2293 by <prefixes> eg: G,M,2
2295 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
2296 origin_itu <numbers>
2297 origin_zone <numbers>
2307 There are no examples because WCY Broadcasts only come from one place
2308 and you either want them or not (see UNSET/WCY if you don't want
2311 This command is really provided for future use.
2313 See HELP FILTER for information.
2316 9.7. accept/wcy (extended for sysops) (8)
2318 accept/wcy <call> [input] [0-9] <pattern> WCY filter sysop version
2321 This version allows a sysop to set a filter for a callsign as well as
2322 the default for nodes and users eg:-
2326 accept/wcy node_default all
2327 set/hops node_default 10
2335 accept/wwv [0-9] <pattern> Set an accept WWV filter
2338 It is unlikely that you will want to do this, but if you do then you
2339 can filter on the following fields:-
2343 by <prefixes> eg: G,M,2
2345 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
2346 origin_itu <numbers>
2347 origin_zone <numbers>
2360 accept/wwv by_zone 4
2365 is probably the only useful thing to do (which will only show WWV
2366 broadcasts by stations in the US).
2368 See HELP FILTER for information.
2371 9.9. accept/wwv (extended for sysops) (8)
2373 accept/wwv <call> [input] [0-9] <pattern> WWV filter sysop version
2377 This version allows a sysop to set a filter for a callsign as well as
2378 the default for nodes and users eg:-
2382 accept/wwv db0sue-7 1 by_zone 4
2383 accept/wwv node_default all
2384 set/hops node_default 10
2386 accept/wwv user_default by W,K
2394 announce <text> Send an announcement to local users
2397 Send an announcement to LOCAL users only, where <text> is the text of
2398 the announcement you wish to broadcast. If you do not wish to receive
2399 announces, use the set/noannounce command. Any announces made by a
2400 sysop will override set/noannounce.
2403 9.11. announce full (0)
2405 announce full <text> Send an announcement cluster wide
2408 This command will send your announcement across the whole cluster
2413 9.12. announce sysop (5)
2415 announce sysop <text>
2418 Send an announcement to Sysops only
2423 apropos <string> Search the help database
2426 Search the help database for <string> (it isn't case sensitive), and
2427 print the names of all the commands that may be relevant.
2432 bye Exit from the cluster
2435 This will disconnect you from the cluster
2440 catchup <node_call> All|[<msgno> ...] Mark a message as sent
2443 When you send messages the fact that you have forwarded it to another
2444 node is remembered so that it isn't sent again. When you have a new
2445 partner node and you add their callsign to your /spider/msg/forward.pl
2446 file, all outstanding non-private messages will be forwarded to them.
2447 This may well be ALL the non-private messages. You can prevent this by
2448 using these commmands:-
2453 catchup GB7DJK 300 301 302 303 500-510
2458 and to undo what you have just done:-
2462 uncatchup GB7DJK all
2463 uncatchup GB7DJK 300 301 302 303 500-510
2468 which will arrange for them to be forward candidates again.
2470 Order is not important.
2473 9.16. clear/spots (0)
2475 clear/spots [1|all] Clear a spot filter line
2478 This command allows you to clear (remove) a line in a spot filter or
2479 to remove the whole filter.
2481 If you have a filter:-
2486 acc/spot 2 on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
2500 you will be left with:-
2504 acc/spot 2 on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
2518 the filter will be completely removed.
2524 connect <callsign> Start a connection to another DX Cluster
2527 Start a connection process that will culminate in a new connection to
2528 the DX cluster <callsign>. This process creates a new 'client' process
2529 which will use the script in /spider/connect/<callsign> to effect the
2530 'chat' exchange necessary to traverse the network(s) to logon to the
2536 dbavail Show a list of all the databases in the system
2539 The title says it all really, this command lists all the databases
2540 defined in the system. It is also aliased to SHOW/COMMAND.
2545 dbcreate <name> Create a database entry
2546 dbcreate <name> chain <name> [<name>..] Create a chained database
2548 dbcreate <name> remote <node> Create a remote database entry
2551 DBCREATE allows you to define a database in the system. It doesn't
2552 actually create anything, just defines it.
2554 The databases that are created are simple DB_File hash databases, they
2555 are therefore already 'indexed'.
2557 You can define a local database with the first form of the command eg:
2561 You can also chain databases with the addition of the 'chain' keyword.
2562 This will search each database one after the other. A typical example
2565 DBCREATE sdx_qsl chain sql_ad
2567 No checking is done to see if the any of the chained databases exist,
2568 in fact it is usually better to do the above statement first then do
2569 each of the chained databases.
2571 Databases can exist offsite. To define a database that lives on
2575 DBCREATE buckmaster remote gb7dxc
2577 Remote databases cannot be chained; however, the last database in a a
2578 chain can be a remote database eg:
2580 DBCREATE qsl chain gb7dxc
2582 To see what databases have been defined do:
2584 DBAVAIL (or it will have been aliased to SHOW/COMMAND)
2586 It would be normal for you to add an entry into your local Aliases
2587 file to allow people to use the 'SHOW/<dbname>' style syntax. So you
2588 would need to add a line like:-
2595 '^sh\w*/buc', 'dbshow buckmaster', 'dbshow',
2607 to work as they may be used to.
2609 See DBIMPORT for the importing of existing AK1A format data to
2610 databases. See DBSHOW for generic database enquiry
2615 dbimport <dbname> Import AK1A data into a database
2618 If you want to import or update data in bulk to a database you can use
2619 this command. It will either create or update entries into an existing
2620 database. For example:-
2622 DBIMPORT oblast /tmp/OBLAST.FUL
2624 will import the standard OBLAST database that comes with AK1A into the
2625 oblast database held locally.
2630 dbremove <dbname> Delete a database
2633 DBREMOVE will completely remove a database entry and also delete any
2634 data file that is associated with it.
2636 There is no warning, no comeback, no safety net.
2643 will remove the oblast database from the system and it will also
2644 remove the associated datafile.
2648 There is no warning, no comeback, no safety net.
2650 You have been warned.
2655 dbshow <dbname> <key> Display an entry, if it exists, in a database
2658 This is the generic user interface to the database to the database
2659 system. It is expected that the sysop will add an entry to the local
2660 Aliases file so that users can use the more familiar AK1A style of
2670 but if he hasn't and the database really does exist (use DBAVAIL or
2671 SHOW/COMMAND to find out) you can do the same thing with:
2684 debug Set the cluster program into debug mode
2687 Executing this command will only have an effect if you are running the
2688 cluster in debug mode i.e.
2697 It will interrupt the cluster just after the debug command has
2703 directory List messages
2704 directory own List your own messages
2705 directory new List all new messages
2706 directory to <call> List all messages to <call>
2707 directory from <call> List all messages from <call>
2708 directory subject <string> List all messages with <string> in subject
2709 directory <nn> List last <nn> messages
2710 directory <from>-<to> List messages <from> message <to> message
2713 List the messages in the messages directory.
2715 If there is a 'p' one space after the message number then it is a
2716 personal message. If there is a '-' between the message number and the
2718 You can use shell escape characters such as '*' and '?' in the <call>
2721 You can combine some of the various directory commands together eg:-
2727 DIR SUBJECT IOTA 200-250
2732 You can abbreviate all the commands to one letter and use ak1a
2745 9.25. directory (extended for sysops) (5)
2747 Works just like the user command except that sysops can see ALL
2751 9.26. disconnect (8)
2753 disconnect <call> [<call> ...] Disconnect a user or node
2756 Disconnect any <call> connected locally
2761 dx [by <call>] <freq> <call> <remarks> Send a DX spot
2764 This is how you send a DX Spot to other users. You can, in fact, now
2765 enter the <freq> and the <call> either way round.
2773 will all give the same result. You can add some remarks to the end of
2774 the command and they will be added to the spot.
2778 DX FR0G 144600 this is a test
2783 You can credit someone else by saying:-
2787 DX by G1TLH FR0G 144.600 he isn't on the cluster
2792 The <freq> is compared against the available bands set up in the
2793 cluster. See SHOW/BANDS for more information.
2798 export <msgno> <filename> Export a message to a file
2801 Export a message to a file. This command can only be executed on a
2802 local console with a fully privileged user. The file produced will be
2803 in a form ready to be imported back into the cluster by placing it in
2804 the import directory (/spider/msg/import).
2806 This command cannot overwrite an existing file. This is to provide
2807 some measure of security. Any files written will owned by the same
2808 user as the main cluster, otherwise you can put the new files anywhere
2809 the cluster can access. For example:-
2814 9.29. export_users (9)
2816 export_users [<filename>] Export the users database to ascii
2819 Export the users database to a file in ascii format. If no filename is
2820 given then it will export the file to /spider/data/user_asc.
2822 If the file already exists it will be renamed to <filename>.o. In fact
2823 up to 5 generations of the file can be kept each one with an extra 'o'
2826 BE WARNED: this will write to any file you have write access to. No
2827 check is made on the filename (if any) that you specify.
2830 9.30. forward/latlong (8)
2832 forward/latlong <node_call> Send latitude and longitude information to
2836 This command sends all the latitude and longitude information that
2837 your cluster is holding against callsigns. One advantage of recieving
2838 this information is that more locator information is held by you.
2839 This means that more locators are given on the DX line assuming you
2840 have set/dxgrid enabled. This could be a LOT of information though,
2841 so it is not recommended on slow links.
2844 9.31. forward/opername (1)
2846 forward/opername <call> Send out information on this <call> to all
2850 This command sends out any information held in the user file which can
2851 be broadcast in PC41 protocol packets. This information is Name, QTH,
2852 Location and Homenode. PC41s are only sent for the information that is
2858 help <cmd> Get help on a command
2861 All commands can be abbreviated, so SHOW/DX can be abbreviated to
2862 SH/DX, ANNOUNCE can be shortened to AN and so on.
2864 Look at the APROPOS <string> command which will search the help
2865 database for the <string> you specify and give you a list of likely
2866 commands to look at with HELP.
2871 init <node call> Re-initialise a link to an AK1A compatible node
2874 This command attempts to re-initialise a link to a (usually) AK1A node
2875 that has got confused, usually by a protocol loop of some kind. It may
2876 work - but you usually will be better off simply disconnecting it (or
2877 better, if it is a real AK1A node, doing an RCMD <node> DISC/F <your
2880 Best of luck - you will need it.
2885 kill <msgno> [<msgno> ..] Delete a message from the local system
2888 Delete a message from the local system. You will only be able to
2889 delete messages that you have originated or been sent (unless you are
2895 kill <msgno> [<msgno> ...] Remove or erase a message from the system
2896 kill from <call> Remove all messages from a callsign
2897 kill to <call> Remove all messages to a callsign
2900 You can get rid of any message to or originating from your callsign
2901 using this command. You can remove more than one message at a time.
2903 As a sysop you can kill any message on the system.
2907 kill full <msgno> [<msgno>] Delete a message from the whole cluster
2910 Delete a message (usually a 'bulletin') from the whole cluster system.
2912 This uses the subject field, so any messages that have exactly the
2913 same subject will be deleted. Beware!
2918 links Show which nodes are physically connected
2921 This is a quick listing that shows which links are connected and some
2922 information about them. See WHO for a list of all connections.
2926 9.38. load/aliases (9)
2928 load/aliases Reload the command alias table
2931 Reload the /spider/cmd/Aliases file after you have editted it. You
2932 will need to do this if you change this file whilst the cluster is
2933 running in order for the changes to take effect.
2936 9.39. load/badmsg (9)
2938 load/badmsg Reload the bad message table
2941 Reload the /spider/msg/badmsg.pl file if you have changed it manually
2942 whilst the cluster is running. This table contains a number of perl
2943 regular expressions which are searched for in the fields targetted of
2944 each message. If any of them match then that message is immediately
2948 9.40. load/bands (9)
2950 load/bands Reload the band limits table
2953 Reload the /spider/data/bands.pl file if you have changed it manually
2954 whilst the cluster is running.
2957 9.41. load/cmd_cache (9)
2959 load/cmd_cache Reload the automatic command cache
2962 Normally, if you change a command file in the cmd or local_cmd tree it
2963 will automatially be picked up by the cluster program. Sometimes it
2964 can get confused if you are doing a lot of moving commands about or
2965 delete a command in the local_cmd tree and want to use the normal one
2966 again. Execute this command to reset everything back to the state it
2967 was just after a cluster restart.
2971 9.42. load/forward (9)
2973 load/forward Reload the msg forwarding routing table
2975 Reload the /spider/msg/forward.pl file if you have changed it manually
2976 whilst the cluster is running.
2979 9.43. load/messages (9)
2981 load/messages Reload the system messages file
2984 If you change the /spider/perl/Messages file (usually whilst
2985 fiddling/writing ne commands) you can have them take effect during a
2986 cluster session by executing this command. You need to do this if get
2989 unknown message 'xxxx' in lang 'en'
2992 9.44. load/prefixes (9)
2994 load/prefixes Reload the prefix table
2997 Reload the /spider/data/prefix_data.pl file if you have changed it
2998 manually whilst the cluster is running.
3003 merge <node> [<no spots>/<no wwv>] Ask for the latest spots and WWV
3006 MERGE allows you to bring your spot and wwv database up to date. By
3007 default it will request the last 10 spots and 5 WWVs from the node you
3008 select. The node must be connected locally.
3010 You can request any number of spots or wwv and although they will be
3011 appended to your databases they will not duplicate any that have
3012 recently been added (the last 2 days for spots and last month for WWV
3018 msg <cmd> <msgno> [data ...] Alter various message parameters
3021 Alter message parameters like To, From, Subject, whether private or
3022 bulletin or return receipt (RR) is required or whether to keep this
3023 message from timing out.
3037 MSG TO <msgno> <call> - change TO callsign to <call>
3038 MSG FRom <msgno> <call> - change FROM callsign to <call>
3039 MSG PRrivate <msgno> - set private flag
3040 MSG NOPRrivate <msgno> - unset private flag
3041 MSG RR <msgno> - set RR flag
3042 MSG NORR <msgno> - unset RR flag
3043 MSG KEep <msgno> - set the keep flag (message won't be deleted ever)
3044 MSG NOKEep <msgno> - unset the keep flag
3045 MSG SUbject <msgno> <new> - change the subject to <new>
3046 MSG WAittime <msgno> - remove any waitting time for this message
3047 MSG NOREad <msgno> - mark message as unread
3048 MSG REad <msgno> - mark message as read
3049 MSG QUeue - queue any outstanding bulletins
3050 MSG QUeue 1 - queue any outstanding private messages
3055 You can look at the status of a message by using:-
3059 This will display more information on the message than DIR does.
3064 pc <call> <text> Send text (eg PC Protocol) to <call>
3067 Send some arbitrary text to a locally connected callsign. No
3068 processing is done on the text. This command allows you to send PC
3069 Protocol to unstick things if problems arise (messages get stuck etc).
3072 pc gb7djk PC33^GB7TLH^GB7DJK^400^
3074 You can also use in the same way as a talk command to a connected user
3075 but without any processing, added of "from <blah> to <blah>" or
3078 pc G1TLH Try doing that properly!!!
3083 ping <node> Check the link quality between nodes
3086 his command allows you to send a frame to another cluster node on the
3087 network and get a return frame. The time it takes to do this is a
3088 good indication of the quality of the link. The actual time it takes
3089 is output to the console in seconds. Any visible cluster node can be
3096 rcmd <node call> <cmd> Send a command to another DX cluster
3099 This command allows you to send nearly any command to another DX
3100 Cluster node that is connected to the system.
3103 Whether you get any output is dependant on a) whether the other system
3104 knows that the node callsign of this cluster is in fact a node b)
3105 whether the other system is allowing RCMDs from this node and c)
3106 whether you have permission to send this command at all.
3111 read Read the next unread personal message addressed to you
3112 read <msgno> Read the specified message
3115 You can read any messages that are sent as 'non-personal' and also any
3116 message either sent by or sent to your callsign.
3120 9.51. read (extended for sysops) (5)
3122 read <msgno> Read a message on the system
3125 As a sysop you may read any message on the system
3128 9.52. reject/announce
3130 reject/announce [0-9] <pattern> Set a reject filter for announce
3133 Create an 'reject this announce' line for a filter.
3135 An reject filter line means that if the announce matches this filter
3136 it is passed onto the user. See HELP FILTERS for more info. Please
3137 read this to understand how filters work - it will save a lot of grief
3140 You can use any of the following things in this line:-
3144 info <string> eg: iota or qsl
3145 by <prefixes> eg: G,M,2
3147 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
3148 origin_itu <numbers>
3149 origin_zone <numbers>
3154 wx 1 filter WX announces
3155 dest <prefixes> eg: 6MUK,WDX (distros)
3164 rej/ann by_zone 14,15,16 and not by G,M,2
3169 You can use the tag 'all' to reject everything eg:
3178 but this probably for advanced users...
3181 9.53. reject/announce (extended for sysops) (8)
3183 reject/announce <call> [input] [0-9] <pattern> Announce filter sysop
3187 This version allows a sysop to set a filter for a callsign as well as
3188 the default for nodes and users eg:-
3193 reject/ann input node_default by G,M,2
3194 reject/ann user_default by G,M,2
3200 9.54. reject/route (8)
3202 reject/route <call> [0-9] <pattern> Set an 'reject' filter line for
3206 Create an 'reject this routing PC Protocol' line for a filter.
3209 An reject filter line means that if a PC16/17/19/21/24/41/50 matches
3210 this filter it is NOT passed thru that interface. See HELP FILTERING
3211 for more info. Please read this to understand how filters work - it
3212 will save a lot of grief later on. You can use any of the following
3213 things in this line:-
3217 call <prefixes> the callsign of the thingy
3218 call_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
3221 origin <prefixes> really the interface it came in on
3222 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
3223 origin_itu <numbers>
3224 origin_zone <numbers>
3235 rej/route gb7djk call_dxcc 61,38 (everything except UK+EIRE nodes)
3241 You can use the tag 'all' to reject everything eg:
3245 rej/route all (equiv to [very] restricted mode)
3251 9.55. reject/spots (0)
3253 reject/spots [0-9] <pattern> Set a reject filter line for spots
3256 Create a 'reject this spot' line for a filter.
3258 A reject filter line means that if the spot matches this filter it is
3259 dumped (not passed on). See HELP FILTERS for more info. Please read
3260 this to understand how filters work - it will save a lot of grief
3263 You can use any of the following things in this line:-
3267 freq <range> eg: 0/30000 or hf or hf/cw or 6m,4m,2m
3268 on <range> same as 'freq'
3269 call <prefixes> eg: G,PA,HB9
3270 info <string> eg: iota or qsl
3272 call_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
3284 For frequencies, you can use any of the band names defined in
3285 SHOW/BANDS and you can use a subband name like: cw, rtty, data, ssb -
3286 thus: hf/ssb. You can also just have a simple range like: 0/30000 -
3287 this is more efficient than saying simply: on HF (but don't get too
3295 rej/spot 2 on vhf and not (by_zone 14,15,16 or call_zone 14,15,16)
3301 You can use the tag 'all' to reject everything eg:
3310 but this probably for advanced users...
3313 9.56. reject/spots (extended for sysops) (8)
3315 reject/spots <call> [input] [0-9] <pattern> Reject spot filter sysop
3319 This version allows a sysop to set a filter for a callsign as well as
3320 the default for nodes and users eg:-
3324 reject/spot db0sue-7 1 by_zone 14,15,16
3325 reject/spot node_default all
3326 set/hops node_default 10
3328 reject/spot user_default by G,M,2
3334 9.57. reject/wcy (0)
3336 reject/wcy [0-9] <pattern> Set a reject WCY filter
3339 It is unlikely that you will want to do this, but if you do then you
3340 can filter on the following fields:-
3344 by <prefixes> eg: G,M,2
3346 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
3347 origin_itu <numbers>
3348 origin_zone <numbers>
3357 There are no examples because WCY Broadcasts only come from one place
3358 and you either want them or not (see UNSET/WCY if you don't want
3361 This command is really provided for future use.
3363 See HELP FILTER for information.
3367 9.58. reject/wcy (extended for sysops) (8)
3369 reject/wcy <call> [input] [0-9] <pattern> WCY reject filter sysop
3373 This version allows a sysop to set a filter for a callsign as well as
3374 the default for nodes and users eg:-
3376 reject/wcy gb7djk all
3379 9.59. reject/wwv (0)
3381 reject/wwv [0-9] <pattern> Set a reject WWV filter
3384 It is unlikely that you will want to do this, but if you do then you
3385 can filter on the following fields:-
3389 by <prefixes> eg: G,M,2
3391 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
3392 origin_itu <numbers>
3393 origin_zone <numbers>
3406 reject/wwv by_zone 14,15,16
3411 is probably the only useful thing to do (which will only show WWV
3412 broadcasts by stations in the US).
3414 See HELP FILTER for information.
3417 9.60. reject/wwv (extended for sysops) (8)
3419 reject/wwv <call> [input] [0-9] <pattern> WWV reject filter sysop
3423 This version allows a sysop to set a filter for a callsign as well as
3424 the default for nodes and users eg:-
3428 reject/wwv db0sue-7 1 by_zone 4
3429 reject/wwv node_default all
3431 reject/wwv user_default by W
3435 reply Reply (privately) to the last message that you have read
3436 reply <msgno> Reply (privately) to the specified message
3437 reply B <msgno> Reply as a Bulletin to the specified message
3438 reply NOPrivate <msgno> Reply as a Bulletin to the specified message
3439 reply RR <msgno> Reply to the specified message with read receipt
3442 You can reply to a message and the subject will automatically have
3443 "Re:" inserted in front of it, if it isn't already present.
3445 You can also use all the extra qualifiers such as RR, PRIVATE,
3446 NOPRIVATE, B that you can use with the SEND command (see SEND for
3452 send <call> [<call> ...] Send a message to one or more callsigns
3453 send RR <call> Send a message and ask for a read receipt
3454 send COPY <msgno> <call> Send a copy of a message to someone
3455 send PRIVATE <call> Send a personal message
3456 send NOPRIVATE <call> Send a message to all stations
3459 All the SEND commands will create a message which will be sent either
3460 to an individual callsign or to one of the 'bulletin' addresses.
3462 SEND <call> on its own acts as though you had typed SEND PRIVATE, that
3463 is it will mark the message as personal and send it to the cluster
3464 node that that callsign is connected to.
3466 You can have more than one callsign in all of the SEND commands.
3468 You can have multiple qualifiers so that you can have for example:-
3472 SEND RR COPY 123 PRIVATE G1TLH G0RDI
3477 which should send a copy of message 123 to G1TLH and G0RDI and you
3478 will receive a read receipt when they have read the message.
3480 SB is an alias for SEND NOPRIVATE (or send a bulletin in BBS speak) SP
3481 is an alias for SEND PRIVATE
3484 9.63. set/address (0)
3486 set/address <your_address> Record your postal address
3489 Literally, record your address details on the cluster.
3492 9.64. set/announce (0)
3494 set/announce Allow announce messages
3497 Allow announce messages to arrive at your terminal.
3499 9.65. set/arcluster (5)
3501 set/arcluster <node_call> [<node_call> ...] Make the node_call an AR-
3505 Set the node_call as an AR-Cluster type node
3510 set/baddx <call> Stop words we do not wish to see in the callsign
3511 field of a dx spot being propagated
3514 Setting a word as 'baddx' will prevent spots with that word in the
3515 callsign field of a DX spot from going any further. They will not be
3516 displayed and they will not be sent onto other nodes.
3518 The word must be wriiten in full, no wild cards are allowed eg:-
3522 set/baddx FORSALE VIDEO FR0G
3527 To allow a word again, use the following command ...
3537 9.67. set/badnode (6)
3539 set/badnode <node_call> Stop spots from this node_call being
3543 Setting a callsign as a 'badnode' will prevent spots from that node
3544 going any further. They will not be displayed and they will not be
3545 sent onto other nodes.
3547 The call can be a full or partial call (or a prefix), eg:-
3556 will stop anything from K1TTT (including any SSID's)
3565 will allow spots from him again.
3567 Use with extreme care. This command may well be superceded by
3571 9.68. set/badspotter (8)
3573 set/badspotter <call> Stop spots from this callsign being propagated
3576 Setting a callsign as a 'badspotter' will prevent spots from this
3577 callsign going any further. They will not be displayed and they will
3578 not be sent onto other nodes.
3580 The call must be written in full, no wild cards are allowed eg:-
3584 set/badspotter VE2STN
3589 will stop anything from VE2STN. If you want SSIDs as well then you
3590 must enter them specifically.
3594 unset/badspotter VE2STN
3599 will allow spots from him again.
3601 Use with extreme care. This command may well be superceded by
3607 set/beep Add beeps to terminal messages
3610 Add a beep to DX and other terminal messages.
3615 set/bbs <call> [<call>..]Make <call> a BBS
3620 set/clx <node_call> [<node_call> ...] Make the node_call a CLX type
3624 Set the node_call as a CLX type node
3629 set/debug <name> Add a debug level to the debug set
3631 You can choose to log several different levels. The levels are
3633 chan state msg cron connect
3635 You can show what levels you are logging with the show/debug command.
3637 You can remove a debug level with unset/debug <name>
3642 set/dxAllow DX messages to arrive at your terminal
3645 You can stop DX messages with the unset/dx command
3648 9.74. set/dxgrid (0)
3650 set/dxgridAllow grid squares on the end of DX messages
3653 Some logging programs do not like the additional information at the
3654 end of a DX spot. If this is the case, use the unset/dxgrid command
3655 to remove the grid squares.
3660 set/dxnet <node_call> [<node_call> ...] Make the node_call a DXNet
3664 Set the node_call as a DXNet type node
3669 set/echo Make the cluster echo your input
3672 If you are connected via a telnet session, different implimentations
3673 of telnet handle echo differently depending on whether you are
3674 connected via port 23 or some other port. You can use this command to
3675 change the setting appropriately.
3677 You can remove the echo with the unset/echo command
3679 The setting is stored in your user profile.
3681 YOU DO NOT NEED TO USE THIS COMMAND IF YOU ARE CONNECTED VIA AX25.
3686 set/here Set the here flag
3689 Let others on the cluster know you are here by only displaying your
3690 callsign. If you are away from your terminal you can use the
3691 unset/here command to let people know you are away. This simply puts
3692 brackets around your callsign to indicate you are not available.
3697 9.78. set/homenode (0)
3699 set/homenode <node_call> Set your home cluster
3702 Tell the cluster system where you normally connect to. Any Messages
3703 sent to you will normally find their way there should you not be
3716 set/hops <node_call> ann|spots|wwv|wcy <n> Set hop count
3719 Set the hop count for a particular type of broadcast for a node.
3721 This command allows you to set up special hop counts for a node for
3722 currently: announce, spots, wwv and wcy broadcasts.
3727 set/hops gb7djk ann 10
3728 set/hops gb7mbc spots 20
3733 Set SHOW/HOPS for information on what is already set. This command
3734 creates a filter and works in conjunction with the filter system.
3737 9.80. set/isolate (9)
3739 set/isolate <node call> Isolate a node from the rest of the network
3742 Connect a node to your system in such a way that you are a full
3743 protocol member of its network and can see all spots on it, but
3744 nothing either leaks out from it nor goes back into from the rest of
3745 the nodes connected to you.
3747 You can potentially connect several nodes in this way.
3749 You can see which nodes are isolated with the show/isolate (1)
3752 You can remove the isolation with the command unset/isolate.
3755 9.81. set/language (0)
3757 set/language <language> Set the language you wish to use
3760 You can select the language that you want the cluster to use.
3761 Currently the languages available are en (English) and nl (Dutch).
3763 9.82. set/location (0)
3765 set/location <lat and long> Set your latitude and longitude
3768 You can set your latitude and longitude manually or alternatively use
3769 the set/qra command which will do the conversion for you.
3773 set/location 54 04 N 2 02 E
3780 9.83. set/sys_location (9)
3782 set/sys_location <lat & long> Set your cluster latitude and longitude
3785 In order to get accurate headings and such like you must tell the
3786 system what your latitude and longitude is. If you have not yet done a
3787 SET/QRA then this command will set your QRA locator for you. For
3792 SET/LOCATION 52 22 N 0 57 E
3798 9.84. set/logininfo (0)
3800 set/logininfo Show logins and logouts of nodes and users
3803 Show users and nodes when they log in and out of the local cluster.
3804 You can stop these messages by using the unset/logininfo command.
3808 9.85. set/lockout (9)
3810 set/lockout <call> Stop a callsign connecting to the cluster
3813 You can show who is locked out with the show/lockout command. To
3814 allow the user to connect again, use the unset/lockout command.
3819 set/name <your_name> Set your name
3822 Tell the cluster what your name is, eg:-
3831 set/node <call> [<call> ...] Make the callsign an AK1A cluster
3834 Tell the system that the call(s) are to be treated as AK1A cluster and
3835 fed PC Protocol rather normal user commands.
3837 From version 1.41 you can also set the following types of cluster
3849 To see what your nodes are set to, use the show/nodes command.
3852 9.88. set/obscount (9)
3854 set/obscount <count> <node call> Set the 'pump-up' obsolescence
3858 From version 1.35 onwards neighbouring nodes are pinged at regular
3859 intervals (see SET/PINGINTERVAL), usually 300 seconds or 5 minutes.
3860 There is a 'pump-up' counter which is decremented on every outgoing
3861 ping and then reset to the 'obscount' value on every incoming ping.
3862 The default value of this parameter is 2.
3864 What this means is that a neighbouring node will be pinged twice at
3865 (default) 300 second intervals and if no reply has been heard just
3866 before what would be the third attempt, that node is disconnected.
3868 If a ping is heard then the obscount is reset to the full value. Using
3869 default values, if a node has not responded to a ping within 15
3870 minutes, it is disconnected.
3875 set/page <n> Set the number of lines per page
3878 Tell the system how many lines you wish on a page when the number of
3879 lines of output from a command is more than this. The default is 20.
3880 Setting it explicitly to 0 will disable paging.
3890 The setting is stored in your user profile.
3895 9.90. set/password (9)
3897 set/password <callsign> <string> Set a users password
3900 The password for a user can only be set by a full sysop. The string
3901 can contain any characters but any spaces are removed (you can type in
3902 spaces - but they won't appear in the password). You can see the
3903 result with STAT/USER. The password is the usual 30 character baycom
3907 9.91. set/pinginterval (9)
3909 set/pinginterval <time> <node call> Set the ping time to neighbouring
3913 As from version 1.35 all neighbouring nodes are pinged at regular
3914 intervals in order to determine the rolling quality of the link and,
3915 in future, to affect routing decisions. The default interval is 300
3918 You can use this command to set a different interval. Please don't.
3920 But if you do the value you enter is treated as minutes up 60 and
3921 seconds for numbers greater than that.
3923 This is used also to help determine when a link is down at the far end
3924 (as certain cluster software doesn't always notice), see SET/OBSCOUNT
3925 for more information.
3928 9.92. set/privilege (9)
3930 set/privilege <n> <call> [<call> ...] Set the privilege level on a
3934 Set the privilege level on a callsign. The privilege levels that
3935 pertain to commands are as default:-
3940 1 - allow remote nodes normal user RCMDs
3941 5 - various privileged commands (including shutdown, but not disc-
3942 connect), the normal level for another node.
3943 8 - more privileged commands (including disconnect)
3944 9 - local sysop privilege. DO NOT SET ANY REMOTE USER OR NODE TO THIS
3950 If you are a sysop and you come in as a normal user on a remote
3951 connection your privilege will automatically be set to 0.
3954 9.93. set/spider (5)
3956 set/spider <node_call> [<node_call> ...] Make the node_call a DXSpider
3961 Set the node_call as a DXSpider type node
3964 9.94. set/sys_qra (9)
3966 set/sys_qra <locator> Set your cluster QRA locator
3971 set/qra <locator> Set your QRA locator
3974 Tell the system what your QRA (or Maidenhead) locator is. If you have
3975 not done a SET/LOCATION then your latitude and longitude will be set
3976 roughly correctly (assuming your locator is correct ;-). For example:-
3988 set/qth <your QTH> Set your QTH
3991 Tell the system where your are. For example:-
3995 set/qth East Dereham, Norfolk
4003 set/talk Allow talk messages to be seen at your console
4006 Allow talk messages to arrive at your console. You can switch off
4007 talks with the unset/talk command.
4012 set/wcy Allow WCY messages to be seen at your console
4015 Allow WCY information to be seen at your console. You can switch off
4016 WCY messages with the unset/wcy command.
4021 set/wwv Allow WWV messages to be seen at your console
4024 Allow WWV information to be seen at your console. You can switch off
4025 WWV messages with the unset/wwv command.
4029 set/wx Allow WX messages to be seen at your console
4032 Allow WX information to be seen at your console. You can switch off
4033 WX messages with the unset/wx command.
4036 9.101. show/baddx (1)
4038 show/baddxShow all the bad dx calls in the system
4041 Display all the bad dx callsigns in the system, see SET/BADDX for more
4045 9.102. show/badnode (6)
4047 show/badnode Show all the bad nodes in the system
4050 Display all the bad node callsigns in the system, see SET/BADNODE for
4054 9.103. show/badspotter (1)
4056 show/badspotter Show all the bad spotters in the system
4059 Display all the bad spotter's callsigns in the system, see
4060 SET/BADSPOTTER for more information.
4063 9.104. show/configuration (0)
4065 show/configuration [<node>] Show all visible nodes and their users
4068 This command allows you to see all the users that can be seen and the
4069 nodes to which they are connected. With the optional node, you can
4070 specify a particular node to look at.
4072 This command is normally abbreviated to: sh/c
4074 BE WARNED: the list that is returned can be VERY long
4077 9.105. show/configuration/node (0)
4079 show/configuration/node Show all the nodes connected
4082 Show all the nodes connected locally and the nodes they have
4086 9.106. show/connect (1)
4088 show/connect Show all the active connections
4091 This command shows information on all the active connections known to
4092 the node. This command gives slightly more information than WHO.
4093 9.107. show/date (0)
4095 show/date [<prefix>|<callsign>] Show the local time
4098 This is very nearly the same as SHOW/TIME, the only difference the
4099 format of the date string if no arguments are given.
4101 If no prefixes or callsigns are given then this command returns the
4102 local time and UTC as the computer has it right now. If you give some
4103 prefixes then it will show UTC and UTC + the local offset (not
4104 including DST) at the prefixes or callsigns that you specify.
4107 9.108. show/debug (9)
4109 show/debug Show what levels of debug you are logging
4112 The levels can be set with set/debug
4117 show/dx [options] interrogate the spot database
4120 If you just type SHOW/DX you will get the last so many spots (sysop
4121 configurable, but usually 10).
4123 In addition you can add any number of these options in very nearly any
4124 order to the basic SHOW/DX command, they are:-
4129 on <band> - eg 160m 20m 2m 23cm 6mm
4130 on <region> - eg hf vhf uhf shf (see SHOW/BANDS)
4132 <number> - the number of spots you want
4133 <from>-<to> - <from> spot no <to> spot no in
4136 <prefix> - for a spotted callsign beginning with <prefix>
4137 *<suffix> - for a spotted callsign ending in <suffix>
4138 *<string>* - for a spotted callsign containing <string>
4140 day <number> - starting <number> days ago
4141 day <from>-<to> - <from> days <to> days ago
4143 info <text> - any spots containing <text> in the info or remarks
4145 by <call> - any spots spotted by <call> (spotter <call>
4148 qsl - this automatically looks for any qsl info on the call
4149 held in the spot database.
4151 iota [<iota>] - If the iota island number is missing it will
4152 look for the string iota and anything which looks like
4153 an iota island number. If you specify then it will look
4156 qra [<locator>] - this will look for the specific locator if
4157 you specify one or else anything that looks like a locator.
4165 SH/DX on 20m info iota
4166 SH/DX 9a on vhf day 30
4176 9.110. show/dxcc (0)
4178 show/dxcc <prefix> Interrogate the spot database by country
4181 This command takes the <prefix> (which can be a full or partial
4182 callsign if desired), looks up which internal country number it is and
4183 then displays all the spots as per SH/DX for that country.
4185 The options for SHOW/DX also apply to this command. e.g.
4191 SH/DXCC W on 20m info iota
4197 9.111. show/files (0)
4199 show/files [<filearea> [<string>]] List the contents of a filearea
4202 SHOW/FILES on its own will show you a list of the various fileareas
4203 available on the system. To see the contents of a particular file area
4213 where <filearea> is the name of the filearea you want to see the
4216 You can also use shell globbing characters like '*' and '?' in a
4217 string to see a selection of files in a filearea eg:-
4221 SH/FILES bulletins arld*
4225 See also TYPE - to see the contents of a file.
4228 9.112. show/filter (0)
4230 show/filter Show the filters you have set
4233 Show the contents of all the filters that are set by you. This command
4234 displays all the filters set - for all the various categories.
4237 9.113. show/filter (extended for sysops) (5)
4239 show/filter <callsign> Show the filters set by <callsign>
4242 A sysop can look at any filters that have been set.
4245 9.114. show/hops (8)
4247 show/hops <node_call> [ann|spots|wcy|wwv|] Show the hop counts for a
4251 This command shows the hop counts set up for a node. You can specify
4252 which category you want to see. If you leave the category out then all
4253 the categories will be listed.
4256 9.115. show/isolate (1)
4258 show/isolate Show a list of isolated nodes
4261 Show which nodes are currently set to be isolated.
4264 9.116. show/lockout (9)
4266 show/lockout Show a list of excluded callsigns
4269 Show a list of callsigns that have been excluded (locked out) of the
4270 cluster locally with the set/lockout command
4275 show/log [<callsign>] Show excerpts from the system log
4278 This command outputs a short section of the system log. On its own it
4279 will output a general logfile. With the optional callsign it will
4280 show output from the log associated with that callsign.
4283 9.118. show/moon (0)
4285 show/moon [<prefix>|<callsign>] Show moon rise and set times
4288 Show the Moon rise and set times for a (list of) prefixes or
4289 callsigns, together with the azimuth and elevation of the sun
4290 currently at those locations.
4291 If you don't specify any prefixes or callsigns, it will show the times
4292 for your QTH (assuming you have set it with either SET/LOCATION or
4293 SET/QRA), together with the current azimuth and elevation.
4295 In addition, it will show the gain or loss dB relative to the nominal
4296 distance of 385,000Km due to the ellipsoidal nature of the orbit.
4298 If all else fails it will show the Moonrise and set times for the node
4299 that you are connected to.
4314 show/muf <prefix> [<hours>][long] Show the likely propagation to
4318 This command allow you to estimate the likelihood of you contacting a
4319 station with the prefix you have specified. The output assumes a
4320 modest power of 20dBW and receiver sensitivity of -123dBm (about
4323 The result predicts the most likely operating frequencies and signal
4324 levels for high frequency (shortwave) radio propagation paths on
4325 specified days of the year and hours of the day. It is most useful for
4326 paths between 250 km and 6000 km, but can be used with reduced
4327 accuracy for paths shorter or longer than this.
4329 The command uses a routine MINIMUF 3.5 developed by the U.S. Navy and
4330 used to predict the MUF given the predicted flux, day of the year,
4331 hour of the day and geographic coordinates of the transmitter and
4332 receiver. This routine is reasonably accurate for the purposes here,
4333 with a claimed RMS error of 3.8 MHz, but much smaller and less complex
4334 than the programs used by major shortwave broadcasting organizations,
4335 such as the Voice of America.
4337 The command will display some header information detailing its
4338 assumptions, together with the locations, latitude and longitudes and
4339 bearings. It will then show UTC (UT), local time at the other end
4340 (LT), calculate the MUFs, Sun zenith angle at the midpoint of the path
4341 (Zen) and the likely signal strengths. Then for each frequency for
4342 which the system thinks there is a likelihood of a circuit it prints a
4345 The value is currently a likely S meter reading based on the
4346 conventional 6dB / S point scale. If the value has a '+' appended it
4347 means that it is 1/2 an S point stronger. If the value is preceeded by
4348 an 'm' it means that there is likely to be much fading and by an 's'
4349 that the signal is likely to be noisy.
4351 By default SHOW/MUF will show the next two hours worth of data. You
4352 can specify anything up to 24 hours worth of data by appending the no
4353 of hours required after the prefix. For example:-
4366 RxSens: -123 dBM SFI: 159 R: 193 Month: 10 Day: 21
4367 Power : 20 dBW Distance: 6283 km Delay: 22.4 ms
4368 Location Lat / Long Azim
4369 East Dereham, Norfolk 52 41 N 0 57 E 47
4370 United-States-W 43 0 N 87 54 W 299
4371 UT LT MUF Zen 1.8 3.5 7.0 10.1 14.0 18.1 21.0 24.9 28.0 50.0
4372 18 23 11.5 -35 mS0+ mS2 S3
4373 19 0 11.2 -41 mS0+ mS2 S3
4378 indicating that you will have weak, fading circuits on top band and
4379 80m but usable signals on 40m (about S3).
4390 will get you the above display, but with the next 24 hours worth of
4401 Gives you an estimate of the long path propagation characterics. It
4402 should be noted that the figures will probably not be very useful, nor
4403 terrible accurate, but it is included for completeness.
4406 9.120. show/node (1)
4408 show/node [<node_call> ...] Show the type and version number of nodes
4411 Show the type and version (if connected) of the nodes specified on the
4412 command line. If no callsigns are specified then a sorted list of all
4413 the non-user callsigns known to the system will be displayed.
4416 9.121. show/prefix (0)
4418 show/prefix <callsign> Interrogate the prefix database
4421 This command takes the <callsign> (which can be a full or partial
4422 callsign or a prefix), looks up which internal country number it is
4423 and then displays all the relevant prefixes for that country together
4424 with the internal country no, the CQ and ITU regions.
4430 9.122. show/program (5)
4432 show/program Show the locations of all the included program modules
4435 Show the name and location where every program module was load from.
4436 This is useful for checking where you think you have loaded a .pm file
4442 show/qra <locator> [<locator>] Show the distance between locators
4443 show/qra <lat> <long> Convert latitude and longitude to a locator
4446 This is a multipurpose command that allows you either to calculate the
4447 distance and bearing between two locators or (if only one locator is
4448 given on the command line) the distance and beraing from your station
4449 to the locator. For example:-
4459 The first example will show the distance and bearing to the locator
4460 from yourself, the second example will calculate the distance and
4461 bearing from the first locator to the second. You can use 4 or 6
4464 It is also possible to convert a latitude and longitude to a locator
4465 by using this command with a latitude and longitude as an argument,
4470 SH/QRA 52 41 N 0 58 E
4478 show/qrz <callsign> Show any callbook details on a callsign
4481 This command queries the QRZ callbook server on the internet and
4482 returns any information available for that callsign. This service is
4483 provided for users of this software by http://www.qrz.com
4489 9.125. show/route (0)
4491 show/route <callsign> Show the route to <callsign>
4494 This command allows you to see to which node the callsigns specified
4495 are connected. It is a sort of inverse sh/config.
4505 9.126. show/satellite (0)
4507 show/satellite <name> [<hours> <interval>] Show satellite tracking
4511 Show the tracking data from your location to the satellite of your
4512 choice from now on for the next few hours.
4514 If you use this command without a satellite name it will display a
4515 list of all the satellites known currently to the system.
4517 If you give a name then you can obtain tracking data of all the passes
4518 that start and finish 5 degrees below the horizon. As default it will
4519 give information for the next three hours for every five minute
4522 You can alter the number of hours and the step size, within certain
4525 Each pass in a period is separated with a row of '-----' characters
4532 SH/SAT FENGYUN1 12 2
4540 show/sun [<prefix>|<callsign>] Show sun rise and set times
4543 Show the sun rise and set times for a (list of) prefixes or callsigns,
4544 together with the azimuth and elevation of the sun currently at those
4547 If you don't specify any prefixes or callsigns, it will show the times
4548 for your QTH (assuming you have set it with either SET/LOCATION or
4549 SET/QRA), together with the current azimuth and elevation.
4551 If all else fails it will show the sunrise and set times for the node
4552 that you are connected to.
4560 SH/SUN G1TLH K9CW ZS
4566 9.128. show/time (0)
4568 show/time [<prefix>|<callsign>] Show the local time
4571 If no prefixes or callsigns are given then this command returns the
4572 local time and UTC as the computer has it right now. If you give some
4573 prefixes then it will show UTC and UTC + the local offset (not
4574 including DST) at the prefixes or callsigns that you specify.
4579 show/wcy Show the last 10 WCY broadcasts
4580 show/wcy <n> Show the last <n> WCY broadcasts
4583 Display the most recent WCY information that has been received by the
4589 show/wwv Show the last 10 WWV broadcasts
4590 show/wwv <n> Show the last <n> WWV broadcasts
4593 Display the most recent WWV information that has been received by the
4600 shutdown Shutdown the cluster
4603 Shutdown the cluster and disconnect all the users. If you have Spider
4604 set to respawn in /etc/inittab it will of course restart.
4609 spoof <callsign> <command> Run commands as another user
4612 This is a very simple yet powerful command for the sysop. It allows
4613 you to issue commands as if you were a different user. This is very
4614 useful for the kind of things that users seem to always get wrong..
4615 like home_node for example.
4623 stat/db <dbname> Show the status of a database
4626 Show the internal status of a database descriptor.
4628 Depending on your privilege level you will see more or less
4629 information. This command is unlikely to be of much use to anyone
4633 9.134. stat/channel (5)
4635 stat/channel <callsign> Show the status of a channel on the cluster
4638 Show the internal status of the channel object either for the channel
4639 that you are on or else for the callsign that you asked for.
4641 Only the fields that are defined (in perl term) will be displayed.
4646 stat/msg <msgno> Show the status of a message
4649 This command shows the internal status of a message and includes
4650 information such as to whom it has been forwarded, its size, origin
4654 If no message number is given then the status of the message system is
4658 9.136. stat/route_node (5)
4660 stat/route_node <callsign> Show the data in a Route::Node object
4663 9.137. stat/route_user (5)
4665 stat/route_user <callsign> Show the data in a Route::User object
4668 9.138. stat/user (5)
4670 stat/user <callsign> Show the full status of a user
4673 Shows the full contents of a user record including all the secret
4676 Only the fields that are defined (in perl term) will be displayed.
4681 sysop Regain your privileges if you login remotely
4684 The system automatically reduces your privilege level to that of a
4685 normal user if you login in remotely. This command allows you to
4686 regain your normal privilege level. It uses the normal system: five
4687 numbers are returned that are indexes into the character array that is
4688 your assigned password (see SET/PASSWORD). The indexes start from
4691 You are expected to return a string which contains the characters
4692 required in the correct order. You may intersperse those characters
4693 with others to obscure your reply for any watchers. For example (and
4694 these values are for explanation :-):
4698 password = 012345678901234567890123456789
4709 aa2bbbb0ccc5ddd7xxx3n
4716 They will all match. If there is no password you will still be offered
4717 numbers but nothing will happen when you input a string. Any match is
4723 talk <callsign> Enter talk mode with <callsign>
4724 talk <callsign> <text> Send a text message to <callsign>
4725 talk <callsign> > <node_call> [<text>] Send a text message to
4726 <callsign> via <node_call>
4729 Send a short message to any other station that is visible on the
4730 cluster system. You can send it to anyone you can see with a
4731 SHOW/CONFIGURATION command, they don't have to be connected locally.
4733 The second form of TALK is used when other cluster nodes are connected
4734 with restricted information. This usually means that they don't send
4735 the user information usually associated with logging on and off the
4738 If you know that G3JNB is likely to be present on GB7TLH, but you can
4739 only see GB7TLH in the SH/C list but with no users, then you would use
4740 the second form of the talk message.
4742 If you want to have a ragchew with someone you can leave the text
4743 message out and the system will go into 'Talk' mode. What this means
4744 is that a short message is sent to the recipient telling them that you
4745 are in a 'Talking' frame of mind and then you just type - everything
4746 you send will go to the station that you asked for.
4748 All the usual announcements, spots and so on will still come out on
4751 If you want to do something (such as send a spot) you precede the
4752 normal command with a '/' character, eg:-
4753 /DX 14001 G1TLH What's a B class licensee doing on 20m CW?
4759 To leave talk mode type:
4771 type <filearea>/<name> Look at a file in one of the fileareas
4774 Type out the contents of a file in a filearea. So, for example, in
4775 filearea 'bulletins' you want to look at file 'arld051' you would
4780 TYPE bulletins/arld051
4785 See also SHOW/FILES to see what fileareas are available and a list of
4791 who Show who is physically connected locally
4794 This is a quick listing that shows which callsigns are connected and
4795 what sort of connection they have
4800 wx <text> Send a weather message to local users
4801 wx full <text> Send a weather message to all cluster users
4804 Weather messages can sometimes be useful if you are experiencing an
4805 extreme that may indicate enhanced conditions
4808 9.144. wx (enhanced for sysops) (5)
4810 wx sysop <text> Send a weather message to other clusters only
4813 Send a weather message only to other cluster nodes and not to general