1 <!doctype linuxdoc system>
\r
5 <!-- Title information -->
\r
7 <title>The DXSpider Administration Manual v1.50</title>
\r
8 <author>Ian Maude, G0VGS, (g0vgs@gb7mbc.net), and
\r
9 Charlie Carroll, K1XX, (k1xx@ptcnh.net)</author>
\r
10 <date>July 2002 revision 0.1</date>
\r
13 A reference for SysOps of the DXSpider DXCluster program.
\r
16 <!-- Table of contents -->
\r
19 <!-- Begin the document -->
\r
21 <sect>Routing and Filtering
\r
26 From DXSpider version 1.48, major changes were introduced to the way
\r
27 node connections are treated. This is part of an ongoing process to
\r
28 remove problems with loops and to enable talk and other functions to
\r
29 propagate across the whole of the worldwide cluster network. In fact,
\r
30 in a Spider network, it would be useful, perhaps even necessary to
\r
31 have loops. This would give real resilience to the network, meaning
\r
32 that if a link dropped, the information flow would simply come in and
\r
33 go out via a different route. Of course, we do not have a complete
\r
34 network of Spider nodes, there are other programs out there. Some of
\r
35 these do not have any protection from loops. Certainly AK1A does not
\r
36 handle loops well at all. It is therefore necessary to have some form
\r
37 of protection for these nodes.
\r
40 In fact DXSpider has had a simple system for some time which is called
\r
41 <it>isolation</it>. This is similar to what in other systems such as
\r
42 <bf>clx</bf>, is called <it>passive mode</it>. A more detailed explanation
\r
43 of <it>isolation</it> is given further below. This system is still available
\r
44 and, for simple networks, is probably all that you need.
\r
47 The new functionality introduced in version 1.48 allows filtering the node
\r
48 and user protocol frames on a "per interface" basis. We call this
\r
49 <it>route filtering</it>. This is used <bf>instead of</bf>
\r
50 <it>isolation</it>.
\r
53 What this really means is that you can control more or less completely
\r
54 which user and node management PC protocol frames pass to each of your
\r
55 partner nodes. You can also limit what comes into your node from your
\r
56 partners. It is even possible to control the settings that your partner
\r
57 node has for the routing information that it sends to you
\r
58 (using the <it>rcmd</it> command).
\r
60 <sect1>Route Filters
\r
63 Initially when route filters were being tested we generated a
\r
64 "default" filter. Unfortunately it quickly became apparent that this
\r
65 might suit the UK cluster network but didn't really fit anybody else.
\r
66 However using a default filter is an appropriate thing to do. How, is
\r
67 explained further on.
\r
70 The first thing that you must do is determine whether you need to use
\r
71 route filtering <bf>at all</bf>. If you are a "normal" node with two or
\r
72 three partners and you arranged in an "official" non-looping tree type
\r
73 network, then <bf>you do not need to do route filtering</bf> and you will
\r
74 feel a lot better for not getting involved. If you are successfully using
\r
75 <it>isolation</it> then you also probably don't need to use route filtering.
\r
78 To put it simply, you should not mix Isolation and Route Filtering. It
\r
79 will work, of sorts, but you will not get the expected results. If you
\r
80 are using Isolation sucessfully at the moment, do not get involved in
\r
81 Route Filtering unless you have a good supply of aspirin! Once you have
\r
82 started down the road of Route Filtering, do not use Isolation either.
\r
83 Use one or the other, not both.
\r
86 You will only require this functionality if you are "well-connected". What
\r
87 that means is that you are connected to several different parts of (say)
\r
88 the EU cluster and, at the same time, also connected to two or three places
\r
89 in the US which, in turn are connected back to the EU. This is called a
\r
90 "loop" and if you are seriously looped then you need filtering.
\r
93 I should at this stage give a little bit of background on filters. All
\r
94 the filters in Spider work in basically the same way. You can either
\r
95 accept or reject various options in order to create the filter rules
\r
96 you wish to achieve. Some filters are user settable, others can only
\r
97 be altered by the sysop. Route filtering can only be done by the sysop.
\r
100 Anyway, without further discouragement, let me start the process
\r
103 <sect1>The node_default filter
\r
106 All normal systems should have a default routing filter and it should
\r
107 usually be set to send only the normal, unlooped, view of your
\r
108 "national" network. Here in the UK that means nodes from the UK and
\r
109 Eire, in EU it is more complex as the networks there grew up in a more
\r
113 The generic commands are:-
\r
116 reject/route node_default <filter_option>
\r
120 accept/route node_default <filter_option>
\r
123 where filter_option is one of the following ...
\r
126 call <prefixes>
\r
127 call_dxcc <numbers>
\r
128 call_itu <numbers>
\r
129 call_zone <numbers>
\r
130 channel <prefixes>
\r
131 channel_dxcc <numbers>
\r
132 channel_itu <numbers>
\r
133 channel_zone <numbers>
\r
136 Please be careful if you alter this setting, it will affect
\r
137 <bf><it>ALL</it></bf> your links! Remember, this is a <it>default</it>
\r
138 filter for node connections, not a <it>per link</it> default.
\r
141 For the default routing filter then you have two real choices: either
\r
142 a "national" view or the "safe" option of only your own
\r
143 callsign. Examples of each (for my node: GB7DJK) are:-
\r
146 acc/route node_default call_dxcc 61,38
\r
147 acc/route node_default call gb7djk
\r
150 GB7DJK uses the first of these. The DXCC countries can be obtained from the
\r
151 <it>show/prefix</it> command.
\r
154 The example filters shown control <it>output</it> <bf>TO</bf> all your
\r
155 partner nodes unless they have a specific filter applied to them (see
\r
159 It is also possible to control the <it>incoming</it> routing
\r
160 information that you are prepared to accept <bf>FROM</bf> your partner
\r
161 nodes. The reason this is necessary is to make sure that stuff like
\r
162 mail, pings and similar commands a) go down the correct links and b)
\r
163 don't loop around excessively. Again using GB7DJK as an example a typical
\r
164 default input filter would be something like:
\r
167 rej/route node_default input call_dxcc 61,38 and not channel_dxcc 61,38
\r
170 What this does is accept node and user information for our national
\r
171 network from nodes that are in our national network, but rejects such
\r
172 information from anyone else. Although it doesn't explicitly say so,
\r
173 by implication, any other node information (not from the UK and Eire)
\r
177 As I imagine it will take a little while to get one's head around all of
\r
178 this you can study the effect of any rules that you try by watching the
\r
179 debug output after having done:-
\r
185 After you have got tired of that, to put it back the way it was:-
\r
191 <sect1>General route filtering
\r
194 Exactly the same rules apply for general route filtering. You would
\r
195 use either an accept filter or a reject filter like this ...
\r
198 reject/route <node_call> <filter_option>
\r
202 accept/route <node_call> <filter_option>
\r
206 Here are some examples of route filters ...
\r
209 rej/route gb7djk call_dxcc 61,38 (send everything except UK+EIRE nodes)
\r
210 rej/route all (equiv to [very] restricted mode)
\r
211 acc/route gb7djk call_dxcc 61,38 (send only UK+EIRE nodes)
\r
212 acc/route gb7djk call gb7djk (equiv to SET/ISOLATE)
\r
215 In practice you will either be opening the default filter out for a
\r
216 partner by defining a specific filter for that callsign:-
\r
219 acc/route gb7baa all
\r
220 acc/route gb7baa input all
\r
223 or restricting it quite a lot, in fact making it very nearly like an
\r
224 <it>isolated</it> node, like this:-
\r
227 acc/route pi4ehv-8 call gb7djk
\r
228 rej/route pi4ehv-8 input call_dxcc 61,38
\r
231 This last example takes everything except UK and Eire from PI4EHV-8
\r
232 but only sends him my local configuration (just a PC19 for GB7DJK and
\r
233 PC16s for my local users).
\r
236 It is possible to write <bf>much</bf> more complex rules, there are up
\r
237 to 10 accept/reject pairs per callsign per filter. For more information
\r
238 see the next section.
\r
241 <sect1>General filter rules
\r
244 Upto v1.44 it was not possible for the user to set their own filters. From
\r
245 v1.45 though that has all changed. It is now possible to set filters for just
\r
246 about anything you wish. If you have just updated from an older version of
\r
247 DXSpider you will need to update your new filters. You do not need to do
\r
248 anything with your old filters, they will be renamed as you update.
\r
251 There are 3 basic commands involved in setting and manipulating filters. These
\r
252 are <em>accept</em>, <em>reject</em> and <em>clear</em>. First we will look
\r
253 generally at filtering. There are a number of things you can filter in the
\r
254 DXSpider system. They all use the same general mechanism.
\r
257 In general terms you can create a "reject" or an "accept" filter which can have
\r
258 up to 10 lines in it. You do this using, for example ...
\r
265 where ..... are the specific commands for that type of filter. There are filters
\r
266 for spots, wwv, announce, wcy and (for sysops) connects. See each different
\r
267 accept or reject command reference for more details.
\r
269 There is also a command to clear out one or more lines in a filter. They are ...
\r
276 There is clear/xxxx command for each type of filter.
\r
279 and you can check that your filters have worked by the command ...
\r
286 For now we are going to use spots for the examples, but you can apply the same
\r
287 principles to all types of filter.
\r
289 <sect1>Types of filter
\r
292 There are two main types of filter, <em>accept</em> or <em>reject</em>. You
\r
293 can use either to achieve the result you want dependent on your own preference
\r
294 and which is more simple to do. It is pointless writing 8 lines of reject
\r
295 filters when 1 accept filter would do the same thing! Each filter has 10
\r
296 lines (of any length) which are tried in order. If a line matches then the
\r
297 action you have specified is taken (ie reject means ignore it and accept
\r
301 If you specify reject filters, then any lines that arrive that match the filter
\r
302 will be dumped but all else will be accepted. If you use an accept filter,
\r
303 then ONLY the lines in the filter will be accepted and all else will be dumped.
\r
304 For example if you have a single line <em>accept</em> filter ...
\r
307 accept/spots on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
\r
310 then you will <em>ONLY</em> get VHF spots <em>from</em> or <em>to</em> CQ zones
\r
314 If you set a reject filter like this ...
\r
317 reject/spots on hf/cw
\r
320 Then you will get everything <em>EXCEPT</em> HF CW spots. You could make this
\r
321 single filter even more flexible. For example, if you are interested in IOTA
\r
322 and will work it even on CW even though normally you are not interested in
\r
323 CW, then you could say ...
\r
326 reject/spots on hf/cw and not info iota
\r
329 But in that case you might only be interested in iota and say:-
\r
332 accept/spots not on hf/cw or info iota
\r
335 which achieves exactly the same thing. You should choose one or the other
\r
336 until you are comfortable with the way it works. You can mix them if you
\r
337 wish (actually you can have an accept AND a reject on the same line) but
\r
338 don't attempt this until you are sure you know what you are doing!
\r
341 You can arrange your filter lines into logical units, either for your own
\r
342 understanding or simply convenience. Here is an example ...
\r
345 reject/spots 1 on hf/cw
\r
346 reject/spots 2 on 50000/1400000 not (by_zone 14,15,16 or call_zone 14,15,16)
\r
349 What this does is to ignore all HF CW spots and also rejects any spots on VHF
\r
350 which don't either originate or spot someone in Europe.
\r
353 This is an example where you would use a line number (1 and 2 in this case), if
\r
354 you leave the digit out, the system assumes '1'. Digits '0'-'9' are available.
\r
355 This make it easier to see just what filters you have set. It also makes it
\r
356 more simple to remove individual filters, during a contest for example.
\r
359 You will notice in the above example that the second line has brackets. Look
\r
360 at the line logically. You can see there are 2 separate sections to it. We
\r
361 are saying reject spots that are VHF or above <em>APART</em> from those in
\r
362 zones 14, 15 and 16 (either spotted there or originated there). If you did
\r
363 not have the brackets to separate the 2 sections, then Spider would read it
\r
364 logically from the front and see a different expression entirely ...
\r
367 (on 50000/1400000 and by_zone 14,15,16) or call_zone 14,15,16
\r
370 The simple way to remember this is, if you use OR - use brackets. Whilst we are
\r
371 here CASE is not important. 'And BY_Zone' is just the same as 'and by_zone'.
\r
373 As mentioned earlier, setting several filters can be more flexible than
\r
374 simply setting one complex one. Doing it in this way means that if you want
\r
375 to alter your filter you can just redefine or remove one or more lines of it or
\r
376 one line. For example ...
\r
379 reject/spots 1 on hf/ssb
\r
382 would redefine our earlier example, or
\r
388 To remove all the filter lines in the spot filter ...
\r
394 <sect1>Filter options
\r
397 You can filter in several different ways. The options are listed in the
\r
398 various helpfiles for accept, reject and filter.
\r
400 <sect1>Default filters
\r
403 Sometimes all that is needed is a general rule for node connects. This can
\r
404 be done with a node_default filter. This rule will always be followed, even
\r
405 if the link is isolated, unless another filter is set specifically. Default
\r
406 rules can be set for nodes and users. They can be set for spots, announces,
\r
407 WWV and WCY. They can also be used for hops. An example might look like
\r
411 accept/spot node_default by_zone 14,15,16,20,33
\r
412 set/hops node_default spot 50
\r
415 This filter is for spots only, you could set others for announce, WWV and WCY.
\r
416 This filter would work for ALL nodes unless a specific filter is written to
\r
417 override it for a particular node. You can also set a user_default should
\r
418 you require. It is important to note that default filters should be
\r
419 considered to be "connected". By this I mean that should you override the
\r
420 default filter for spots, you need to add a rule for the hops for spots also.
\r
422 <sect1>Advanced filtering
\r
425 Once you are happy with the results you get, you may like to experiment.
\r
428 The previous example that filters hf/cw spots and accepts vhf/uhf spots from EU
\r
429 can be written with a mixed filter, for example ...
\r
433 acc/spot on 0/30000
\r
434 acc/spot 2 on 50000/1400000 and (by_zone 14,15,16 or call_zone 14,15,16)
\r
437 Note that the first filter has not been specified with a number. This will
\r
438 automatically be assumed to be number 1. In this case, we have said <em>reject all
\r
439 HF spots in the CW section of the bands but accept all others at HF. Also
\r
440 accept anything in VHF and above spotted in or by operators in the zones
\r
441 14, 15 and 16</em>. Each filter slot actually has a 'reject' slot and
\r
442 an 'accept' slot. The reject slot is executed BEFORE the accept slot.
\r
445 It was mentioned earlier that after a reject test that doesn't match, the default
\r
446 for following tests is 'accept', the reverse is true for 'accept'. In the example
\r
447 what happens is that the reject is executed first, any non hf/cw spot is passed
\r
448 to the accept line, which lets through everything else on HF. The next filter line
\r
449 lets through just VHF/UHF spots from EU.
\r
451 <sect1>Basic hop control
\r
454 In /spider/data you will find a file called hop_table.pl. This is the file
\r
455 that controls your hop count settings. It has a set of default hops on the
\r
456 various PC frames and also a set for each node you want to alter the hops for.
\r
457 You may be happy with the default settings of course, but this powerful tool
\r
458 can help to protect and improve the network. The file will look something
\r
463 # hop table construction
\r
468 # default hopcount to use
\r
471 # some variable hop counts based on message type
\r
482 # the per node hop control thingy
\r
487 GB7ADX => { 11 => 8,
\r
495 GB7UDX => { 11 => 8,
\r
514 Each set of hops is contained within a pair of curly braces and contains a
\r
515 series of PC frame types. PC11 for example is a DX spot. The figures here
\r
516 are not exhaustive but should give you a good idea of how the file works.
\r
519 SHould any of the nodecalls include an ssid, it is important to wrap the
\r
520 whole call in single quotes, like this ...
\r
533 If you do not do this, you will get errors and the file will not work as
\r
537 You can alter this file at any time, including whilst the cluster is running.
\r
538 If you alter the file during runtime, the command <em>load/hops</em> will
\r
539 bring your changes into effect.
\r
541 <sect1>Hop Control on Specific Nodes
\r
543 <p>You can set a callsign specific hop count for any of the standard filter
\r
547 set/hops gb7djk spot 4
\r
548 set/hops node_default route 10
\r
549 set/hops gb7baa wcy 5
\r
552 all work on their specific area of the protocol.
\r
555 The <em>set/hops</em> command overrides any hops that you have set otherwise.
\r
558 You can show what hops have been set using the <em>show/hops</em> command.
\r
560 <sect1>Isolating networks
\r
563 It is possible to isolate networks from each other on a "gateway" node using the
\r
564 <em>set/isolate <node_call></em> command.
\r
567 The effect of this is to partition an isolated network completely from another
\r
568 node connected to your node. Your node will appear on and otherwise behave
\r
569 normally on every network to which you are connected, but data from an isolated
\r
570 network will not cross onto any other network or vice versa. However all the
\r
571 spot, announce and WWV traffic and personal messages will still be handled
\r
572 locally (because you are a real node on all connected networks), that is locally
\r
573 connected users will appear on all networks and will be able to access and
\r
574 receive information from all networks transparently. All routed messages will
\r
575 be sent as normal, so if a user on one network knows that you are a gateway for
\r
576 another network, he can still still send a talk/announce etc message via your
\r
577 node and it will be routed across.
\r
580 If you use isolate on a node connection you will continue to receive
\r
581 all information from the isolated partner, however you will not pass
\r
582 any information back to the isolated node. There are times when you
\r
583 would like to forward only spots across a link (maybe during a contest
\r
584 for example). To do this, isolate the node in the normal way and use
\r
585 an <em>acc/spot >call< all</em> filter to override the isolate.
\r
587 <sect>Other filters
\r
589 <sect1>Filtering Mail
\r
592 In the /spider/msg directory you will find a file called badmsg.pl.issue. Rename
\r
593 this to badmsg.pl and edit the file. The original looks something like this ....
\r
597 # the list of regexes for messages that we won't store having
\r
598 # received them (bear in mind that we must receive them fully before
\r
602 # The format of each line is as follows
\r
604 # type source pattern
\r
605 # P/B/F T/F/O/S regex
\r
607 # type: P - private, B - bulletin (msg), F - file (ak1a bull)
\r
608 # source: T - to field, F - from field, O - origin, S - subject
\r
609 # pattern: a perl regex on the field requested
\r
611 # Currently only type B and P msgs are affected by this code.
\r
613 # The list is read from the top down, the first pattern that matches
\r
614 # causes the action to be taken.
\r
616 # The pattern can be undef or 0 in which case it will always be selected
\r
617 # for the action specified
\r
625 'B', 'T', 'WANTED',
\r
626 'B', 'S', 'WANTED',
\r
635 I think this is fairly self explanatory. It is simply a list of subject
\r
636 headers that we do not want to pass on to either the users of the cluster or
\r
637 the other cluster nodes that we are linked to. This is usually because of
\r
638 rules and regulations pertaining to items for sale etc in a particular country.
\r
641 <sect1>Filtering words from text fields in Announce, Talk and DX spots
\r
644 From version 1.48 onwards the interface to this has changed. You can now
\r
645 use the commands <em>set/badword</em> to add words that you are not prepared
\r
646 to see on the cluster, <em>unset/badword</em> to allow that word again and
\r
647 <em>show/badword</em> to list the words that you have set.
\r
650 If you have a previous <em>/spider/data/badwords</em>, the first time you start
\r
651 the node, it will read and convert this file to the new commands. The old style
\r
652 file will then be removed.
\r
654 <sect1>Stopping (possibly bad) DX Spots from Nodes or Spotters
\r
657 There are a number of commands that control whether a spot progresses
\r
658 any further by regarding it as "bad" in some way.
\r
661 A DX Spot has a number of fields which can be checked to see whether they
\r
662 contain "bad" values, they are: the DX callsign itself, the Spotter and
\r
663 the Originating Node.
\r
666 There are a set of commands which allow the sysop to control whether a
\r
675 These work in the same as the <em>set/badword</em> command, you can add
\r
676 any words or callsigns or whatever to the appropriate database. For
\r
677 example, to stop a spot from a particular node you do:
\r
680 set/badnode gb7djk gb7dxc
\r
686 set/badspotter b0mb p1rat nocall
\r
692 set/baddx video wsjt
\r
695 You can remove a word using the appropriate unset command
\r
696 (<em>unset/baddx, unset/badspotter, unset/badnode</em>) or list them
\r
697 using one of <em>show/baddx, show/badspotter</em> and
\r
698 <em>show/badnode</em>.
\r
703 DXSpider deals seamlessly with standard AK1A type mail. It supports both
\r
704 personal and bulletin mail and the sysop has additional commands to ensure
\r
705 that mail gets to where it is meant. DXSpider will send mail almost
\r
706 immediately, assuming that the target is on line. However, only one
\r
707 mail message is dealt with at any one time. If a mail message is already
\r
708 being sent or recieved, then the new message will be queued until it has
\r
711 The cluster mail is automatically deleted after 30 days unless the sysop
\r
712 sets the "keep" flag using the <em>msg</em> command.
\r
714 <sect1>Personal mail
\r
717 Personal mail is sent using the <em>sp</em> command. This is actually the
\r
718 default method of sending mail and so a simple <em>s</em> for send will do.
\r
719 A full list of the send commands and options is in the <em>command set</em>
\r
720 section, so I will not duplicate them here.
\r
722 <sect1>Bulletin mail
\r
725 Bulletin mail is sent by using the <em>sb</em> command. This is one of the
\r
726 most common mistakes users make when sending mail. They send a bulletin
\r
727 mail with <em>s</em> or <em>sp</em> instead of <em>sb</em> and of course
\r
728 the message never leaves the cluster. This can be rectified by the sysop
\r
729 by using the <em>msg</em> command.
\r
731 <P>Bulletin addresses can be set using the Forward.pl file.
\r
736 DXSpider receives all and any mail sent to it without any alterations needed
\r
737 in files. Because personal and bulletin mail are treated differently, there
\r
738 is no need for a list of accepted bulletin addresses. It is necessary, however,
\r
739 to tell the program which links accept which bulletins. For example, it is
\r
740 pointless sending bulletins addresses to "UK" to any links other than UK
\r
741 ones. The file that does this is called forward.pl and lives in /spider/msg.
\r
742 At default, like other spider files it is named forward.pl.issue. Rename it
\r
743 to forward.pl and edit the file to match your requirements.
\r
744 The format is below ...
\r
748 # this is an example message forwarding file for the system
\r
750 # The format of each line is as follows
\r
752 # type to/from/at pattern action destinations
\r
753 # P/B/F T/F/A regex I/F [ call [, call ...] ]
\r
755 # type: P - private, B - bulletin (msg), F - file (ak1a bull)
\r
756 # to/from/at: T - to field, F - from field, A - home bbs, O - origin
\r
757 # pattern: a perl regex on the field requested
\r
758 # action: I - ignore, F - forward
\r
759 # destinations: a reference to an array containing node callsigns
\r
761 # if it is non-private and isn't in here then it won't get forwarded
\r
763 # Currently only type B msgs are affected by this code.
\r
765 # The list is read from the top down, the first pattern that matches
\r
766 # causes the action to be taken.
\r
768 # The pattern can be undef or 0 in which case it will always be selected
\r
769 # for the action specified
\r
771 # If the BBS list is undef or 0 and the action is 'F' (and it matches the
\r
772 # pattern) then it will always be forwarded to every node that doesn't have
\r
773 # it (I strongly recommend you don't use this unless you REALLY mean it, if
\r
774 # you allow a new link with this on EVERY bull will be forwarded immediately
\r
775 # on first connection)
\r
781 'B', 'T', 'LOCAL', 'F', [ qw(GB7MBC) ],
\r
782 'B', 'T', 'ALL', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
783 'B', 'T', 'UK', 'F', [ qw(GB7BAA GB7ADX) ],
\r
784 'B', 'T', 'QSL', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
785 'B', 'T', 'QSLINF', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
786 'B', 'T', 'DX', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
787 'B', 'T', 'DXINFO', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
788 'B', 'T', 'DXNEWS', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
789 'B', 'T', 'DXQSL', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
790 'B', 'T', 'SYSOP', 'F', [ qw(GB7BAA GB7ADX) ],
\r
791 'B', 'T', '50MHZ', 'F', [ qw(GB7BAA GB7ADX PA4AB-14) ],
\r
795 Simply insert a bulletin address and state in the brackets where you wish
\r
796 that mail to go. For example, you can see here that mail sent to "UK" will
\r
797 only be sent to the UK links and not to PA4AB-14.
\r
800 To force the cluster to reread the file use load/forward
\r
803 NB: If a user tries to send mail to a bulletin address that does not exist
\r
804 in this file, they will get an error.
\r
806 <sect1>The msg command
\r
809 The <em>msg</em> command is a very powerful and flexible tool for the
\r
810 sysop. It allows the sysop to alter to and from fields and make other
\r
811 changes to manage the cluster mail.
\r
813 Here is a full list of the various options ...
\r
816 MSG TO <msgno> <call> - change TO callsign to <call>
\r
817 MSG FRom <msgno> <call> - change FROM callsign to <call>
\r
818 MSG PRrivate <msgno> - set private flag
\r
819 MSG NOPRrivate <msgno> - unset private flag
\r
820 MSG RR <msgno> - set RR flag
\r
821 MSG NORR <msgno> - unset RR flag
\r
822 MSG KEep <msgno> - set the keep flag (message won't be deleted ever)
\r
823 MSG NOKEep <msgno> - unset the keep flag
\r
824 MSG SUbject <msgno> <new> - change the subject to <new>
\r
825 MSG WAittime <msgno> - remove any waiting time for this message
\r
826 MSG NOREad <msgno> - mark message as unread
\r
827 MSG REad <msgno> - mark message as read
\r
828 MSG QUeue - queue any outstanding bulletins
\r
829 MSG QUeue 1 - queue any outstanding private messages
\r
832 These commands are simply typed from within the cluster as the sysop user.
\r
834 <sect1>Message status
\r
837 You can check on a message from within the cluster by using the command
\r
838 <em>stat/msg</em>. This will give you additional information on the
\r
839 message number including which nodes have received it, which node it
\r
840 was received from and when etc. Here is an example of the output of
\r
844 G0VGS de GB7MBC 28-Jan-2001 1308Z >
\r
847 Msg Time: 26-Jan-2001 1302Z
\r
851 Subject: AMSAT 2line KEPS 01025.AMSAT
\r
853 Got it Nodes: GB7BAA, GB7ADX
\r
857 G0VGS de GB7MBC 28-Jan-2001 1308Z >
\r
860 <sect1>Filtering mail
\r
863 This is described in the section on <em>Other filters</em> so I will not
\r
866 <sect1>Distribution lists
\r
869 Distribution lists are simply a list of users to send certain types of
\r
870 mail to. An example of this is mail you only wish to send to other
\r
871 sysops. In /spider/msg there is a directory called <em>distro</em>. You
\r
872 put any distibution lists in here. For example, here is a file called
\r
873 SYSOP.pl that caters for the UK sysops.
\r
876 qw(GB7TLH GB7DJK GB7DXM GB7CDX GB7BPQ GB7DXN GB7MBC GB7MBC-6 GB7MDX
\r
877 GB7NDX GB7SDX GB7TDX GB7UDX GB7YDX GB7ADX GB7BAA GB7DXA GB7DXH
\r
878 GB7DXK GB7DXI GB7DXS)
\r
881 Any mail sent to "sysop" would only be sent to the callsigns in this list.
\r
883 <sect1>BBS interface
\r
886 Spider provides a simple BBS interface. No input is required from the sysop
\r
887 of the cluster at all. The BBS simply sets the cluster as a BBS and pushes
\r
888 any required mail to the cluster. No mail can flow from Spider to the BBS,
\r
889 the interface is one-way.
\r
892 Please be careful not to flood the cluster network with unnecessary mail.
\r
893 Make sure you only send mail to the clusters that want it by using the
\r
894 Forward.pl file very carefully.
\r
899 From 1.48 onwards it will become increasingly possible to control DXSpider's
\r
900 operation with scripts of various kinds.
\r
903 The directory /spider/scripts is where it all happens and is used for several
\r
904 things. Firstly it contains a file called startup that can be used to call
\r
905 in any changes to the cluster from the default settings on startup. This
\r
906 script is executed immediately after all initialisation of the node is done
\r
907 but before any connections are possible. Examples of this include how many
\r
908 spots it is possible to get with the sh/dx command, whether you want
\r
909 registration/passwords to be permanently on etc. An example file is shown
\r
910 below and is included in the distribution as startup.issue.
\r
914 # startup script example
\r
916 # set maximum no of spots allowed to 100
\r
917 # set/var $Spot::maxspots = 100
\r
919 # Set registration on
\r
920 # set/var $main::reqreg = 1
\r
923 # set/var $main::passwdreq = 1
\r
928 As usual, any text behind a # is treated as a comment and not read. To use
\r
929 this file, simply rename it from startup.issue to startup. In our example
\r
930 above there are three options. The first option is the amount of spots that
\r
931 a user can request with the <em>sh/dx</em> command. Normally the default is
\r
932 to give 10 spots unless the user specifies more. Without this line enabled,
\r
933 the maximum a user can request is 100 spots. Depending on your link quality
\r
934 you may wish to enable more or less by specifying the number.
\r
937 The other 2 options are dealt with more fully in the security section.
\r
940 Secondly, it is used to store the login scripts for users and nodes. Currently
\r
941 this can only be done by the sysop but it is envisaged that eventually users will
\r
942 be able to set their own. An example is included in the distibution but here is
\r
958 The lines in between commands can simply insert a blank line or a character
\r
959 such as a + sign to make the output easier to read. Simply create this script
\r
960 with your favourite editor and save it with the callsign of the user as the
\r
961 filename. Filenames should always be in lower case.
\r
964 Commands can be inserted in the same way for nodes. A node may wish a series
\r
965 of commands to be issued on login, such as a merge command for example.
\r
968 Thirdly, there are 2 default scripts for users and nodes who do not have a
\r
969 specifically defined script. These are <em>user_default</em> and
\r
970 <em>node_default</em>
\r
975 Spider allows the creation of local or remote databases. It supports
\r
976 chained databases, allowing several different databases to be scanned
\r
977 with one simple command. Importing of databases is limited at present
\r
978 to the standard AK1A databases such as OBLAST and the DB0SDX QSL
\r
979 database but will expand with time.
\r
981 <sect1>Creating databases
\r
984 Creating a database could not be more simple. All the commands are
\r
985 sent from the cluster prompt as the <em>sysop</em> user.
\r
987 To create a database you use the command <em>dbcreate</em>. It can
\r
988 be used in 3 different ways like so ..
\r
994 To simply create a database locally, you just tell the command the
\r
995 name of the database. This does not create the actual database, it
\r
996 simply defines it to say that it exists.
\r
999 dbcreate <name> chain <name> [<name>...]
\r
1002 This creates a chained database entry. The first database will be
\r
1003 scanned, then the second, the third etc...
\r
1006 dbcreate <name> remote <name>
\r
1009 This creates a remote entry. the first name field is the database
\r
1010 name at the remote node, then the remote switch, then the actual
\r
1011 node_call of the remote node, for example...
\r
1014 dbcreate buckmaster remote gb7dxc
\r
1017 Remote databases cannot be chained, however, the last database in a
\r
1018 chain can be a remote database.
\r
1020 <sect1>Importing databases
\r
1023 The only databases that Spider can currently import are the standard
\r
1024 AK1A databases such as OBLAST or the DB0SDX qsl and address database.
\r
1025 This will be added to with time.
\r
1027 To import such a database, first put the file somewhere useful like /tmp
\r
1028 and then issue the following command ...
\r
1031 dbimport oblast /tmp/OBLAST.FUL
\r
1034 This will update the existing local oblast database or create it if
\r
1035 it does not exist.
\r
1037 <sect1>Checking available databases
\r
1040 Once a database is created, you will want to check that it has been
\r
1041 added. To do this use the <em>dbavail</em> command. This will
\r
1042 output the available databases. For example ...
\r
1046 DB Name Location Chain
\r
1050 G0VGS de GB7MBC 3-Feb-2001 1925Z >
\r
1053 <sect1>Looking up databases
\r
1056 To look for information in a defined database, simply use the <em>dbshow</em>
\r
1057 command, for example ...
\r
1060 dbshow buckmaster G0YLM
\r
1063 will show the information for the callsign G0YLM from the buckmaster
\r
1064 database if it exists. To make things more standard for the users
\r
1065 you can add an entry in the Aliases file so that it looks like a standard
\r
1066 <em>show</em> command like this ...
\r
1069 '^sh\w*/buc', 'dbshow buckmaster', 'dbshow',
\r
1072 Now you can simply use show/buckmaster or an abreviation.
\r
1074 <sect1>Removing databases
\r
1077 To delete an existing database you use the <em>dbremove</em> command.
\r
1084 would remove the oblast database and its associated datafile from the
\r
1085 system. There are no warnings or recovery possible from this command.
\r
1086 If you remove a database it ceases to exist and would have to be created
\r
1087 from scratch if you still required it.
\r
1089 <sect>Information, files and useful programs
\r
1094 One of the more important things a cluster sysop needs to do is to get
\r
1095 information to his users. The simplest way to do this is to have a banner
\r
1096 that is sent to the user on login. This is know as a "message of the day"
\r
1097 or "motd". To set this up, simply create a file in /spider/data called motd
\r
1098 and edit it to say whatever you want. It is purely a text file and will be
\r
1099 sent automatically to anyone logging in to the cluster.
\r
1104 This message of the day file lives in the same directory as the standard
\r
1105 motd file but is only sent to non-registered users. Once registered they
\r
1106 will receive the same message as any other user.
\r
1108 <sect1>Downtime message
\r
1111 If for any reason the cluster is down, maybe for upgrade or maintenance but
\r
1112 the machine is still running, a message can be sent to the user advising them
\r
1113 of the fact. This message lives in the /spider/data directory and is called
\r
1114 "offline". Simply create the file and edit it to say whatever you wish.
\r
1115 This file will be sent to a user attempting to log into the cluster when
\r
1116 DXSpider is not actually running.
\r
1118 <sect1>Other text messages
\r
1121 You can set other text messages to be read by the user if they input the file
\r
1122 name. This could be for news items or maybe information for new users.
\r
1123 To set this up, make a directory under /spider called <em>packclus</em>.
\r
1124 Under this directory you can create files called <em>news</em> or <em>newuser</em>
\r
1125 for example. In fact you can create files with any names you like. These can
\r
1126 be listed by the user with the command ....
\r
1132 They can be read by the user by typing the command ....
\r
1138 If the file they want to read is called <em>news</em>. You could also set
\r
1139 an alias for this in the Alias file to allow them just to type <em>news</em>
\r
1142 You can also store other information in this directory, either directly or
\r
1143 nested under directories. One use for this would be to store DX bulletins
\r
1144 such as the OPDX bulletins. These can be listed and read by the user.
\r
1145 To keep things tidy, make a directory under /spider/packclus called
\r
1146 <em>bulletin</em>. Now copy any OPDX or similar bulletins into it. These
\r
1147 can be listed by the user in the same way as above using the <em>show/files</em>
\r
1148 command with an extension for the bulletin directory you have just created,
\r
1152 show/files bulletin
\r
1156 An example would look like this ....
\r
1160 bulletin DIR 20-Dec-1999 1715Z news 1602 14-Dec-1999 1330Z
\r
1163 You can see that in the files area (basically the packclus directory) there is a
\r
1164 file called <em>news</em> and a directory called <em>bulletin</em>. You can
\r
1165 also see that dates they were created. In the case of the file <em>news</em>,
\r
1166 you can also see the time it was last modified, a good clue as to whether the
\r
1167 file has been updated since you last read it. To read the file called
\r
1168 <em>news</em> you would simply issue the command ....
\r
1174 To look what is in the bulletin directory you issue the command ....
\r
1177 show/files bulletin
\r
1178 opdx390 21381 29-Nov-1999 1621Z opdx390.1 1670 29-Nov-1999 1621Z
\r
1179 opdx390.2 2193 29-Nov-1999 1621Z opdx391 25045 29-Nov-1999 1621Z
\r
1180 opdx392 35969 29-Nov-1999 1621Z opdx393 15023 29-Nov-1999 1621Z
\r
1181 opdx394 33429 29-Nov-1999 1621Z opdx394.1 3116 29-Nov-1999 1621Z
\r
1182 opdx395 24319 29-Nov-1999 1621Z opdx396 32647 29-Nov-1999 1621Z
\r
1183 opdx396.1 5537 29-Nov-1999 1621Z opdx396.2 6242 29-Nov-1999 1621Z
\r
1184 opdx397 18433 29-Nov-1999 1621Z opdx398 19961 29-Nov-1999 1621Z
\r
1185 opdx399 17719 29-Nov-1999 1621Z opdx400 19600 29-Nov-1999 1621Z
\r
1186 opdx401 27738 29-Nov-1999 1621Z opdx402 18698 29-Nov-1999 1621Z
\r
1187 opdx403 24994 29-Nov-1999 1621Z opdx404 15685 29-Nov-1999 1621Z
\r
1188 opdx405 13984 29-Nov-1999 1621Z opdx405.1 4166 29-Nov-1999 1621Z
\r
1189 opdx406 28934 29-Nov-1999 1621Z opdx407 24153 29-Nov-1999 1621Z
\r
1190 opdx408 15081 29-Nov-1999 1621Z opdx409 23234 29-Nov-1999 1621Z
\r
1191 Press Enter to continue, A to abort (16 lines) >
\r
1194 You can now read any file in this directory using the type command, like this ....
\r
1197 type bulletin/opdx391
\r
1198 Ohio/Penn DX Bulletin No. 391
\r
1199 The Ohio/Penn Dx PacketCluster
\r
1200 DX Bulletin No. 391
\r
1203 Editor Tedd Mirgliotta, KB8NW
\r
1204 Provided by BARF-80 BBS Cleveland, Ohio
\r
1205 Online at 440-237-8208 28.8k-1200 Baud 8/N/1 (New Area Code!)
\r
1206 Thanks to the Northern Ohio Amateur Radio Society, Northern Ohio DX
\r
1207 Association, Ohio/Penn PacketCluster Network, K1XN & Golist, WB2RAJ/WB2YQH
\r
1208 & The 59(9) DXReport, W3UR & The Daily DX, K3TEJ, KN4UG, W4DC, NC6J, N6HR,
\r
1209 Press Enter to continue, A to abort (508 lines) >
\r
1212 The page length will of course depend on what you have it set to!
\r
1214 <sect1>The Aliases file
\r
1217 You will find a file in /spider/cmd/ called Aliases. This is the file that
\r
1218 controls what a user gets when issuing a command. It is also possible to
\r
1219 create your own aliases for databases and files you create locally.
\r
1222 You should not alter the original file in /spider/cmd/ but create a new file
\r
1223 with the same name in /spider/local_cmd. This means that any new Aliases files
\r
1224 that is downloaded will not overwrite your self created Aliases and also that
\r
1225 you do not override any new Aliases with your copy in /spider/local_cmd/. You
\r
1226 must remember that any files you store in /spider/local/ or /spider/local_cmd
\r
1227 override the originals if the same lines are used in both files.
\r
1230 The best way of dealing with all this then is to only put your own locally
\r
1231 created Aliases in the copy in /spider/local_cmd. The example below is
\r
1232 currently in use at GB7MBC.
\r
1237 # Local Aliases File
\r
1244 '^news$', 'type news', 'type',
\r
1247 '^sh\w*/buck$', 'show/qrz', 'show',
\r
1248 '^sh\w*/hftest$', 'dbshow hftest', 'dbshow',
\r
1249 '^sh\w*/qsl$', 'dbshow qsl', 'dbshow',
\r
1250 '^sh\w*/vhf$', 'dbshow vhf', 'dbshow',
\r
1251 '^sh\w*/vhftest$', 'dbshow vhftest', 'dbshow',
\r
1258 Each alphabetical section should be preceded by the initial letter and the section
\r
1259 should be wrapped in square brackets as you can see. The syntax is straightforward.
\r
1260 The first section on each line is the new command that will be allowed once the
\r
1261 alias is included. The second section is the command it is replacing and the last
\r
1262 section is the actual command that is being used.
\r
1265 The eagle-eyed amongst you will have noticed that in the first section, the new
\r
1266 alias command has a '^' at the start and a '$' at the end. Basically these force
\r
1267 a perfect match on the alias. The '^' says match the beginning exactly and the
\r
1268 '$' says match the end exactly. This prevents unwanted and unintentional matches
\r
1269 with similar commands.
\r
1272 I have 3 different types of alias in this file. At the top is an alias for 'news'.
\r
1273 This is a file I have created in the /spider/packclus/ directory where I can inform
\r
1274 users of new developments or points of interest. In it's initial form a user would
\r
1275 have to use the command <em>type news</em>. The alias allows them to simply type
\r
1276 <em>news</em> to get the info. Second is an alias for the <em>show/qrz</em>
\r
1277 command so that those users used to the original <em>show/buck</em> command in
\r
1278 AK1A will not get an error, and the rest of the lines are for locally created
\r
1279 databases so that a user can type <em>show/hftest</em> instead of having to use
\r
1280 the command <em>dbshow hftest</em> which is not as intuitive.
\r
1283 This file is just an example and you should edit it to your own requirements.
\r
1284 Once created, simply issue the command <em>load/alias</em> at the cluster
\r
1285 prompt as the sysop user and the aliases should be available.
\r
1291 In later versions of Spider a simple console program is provided for the sysop.
\r
1292 This has a type ahead buffer with line editing facilities and colour for spots,
\r
1293 announces etc. To use this program, simply use console.pl instead of client.
\r
1296 To edit the colours, copy /spider/perl/Console.pl to /spider/local and edit the
\r
1297 file with your favourite editor.
\r
1299 <sect1>Updating kepler data
\r
1302 Spider has a powerful and flexible show/satellite command. In order for
\r
1303 this to be accurate, the kepler data has to be updated regularly. In
\r
1304 general, this data is available as an email or via cluster mail.
\r
1305 Updating it is simple. First you need to export the mail message as a
\r
1306 file. You do this with the <em>export</em> command from the cluster prompt
\r
1307 as the sysop. For example ...
\r
1310 export 5467 /spider/perl/keps.in
\r
1314 would export message number 5467 as a file called keps.in in the
\r
1315 /spider/perl directory.
\r
1318 Now login to a VT as sysop and cd /spider/perl. There is a command in
\r
1319 the perl directory called <em>convkeps.pl</em>. All we need to do now is
\r
1320 convert the file like so ...
\r
1323 ./convkeps.pl keps.in
\r
1327 Now go back to the cluster and issue the command ...
\r
1334 That is it! the kepler data has been updated.
\r
1336 <sect1>The QRZ callbook
\r
1339 The command <em>sh/qrz</em> will only work once you have followed a few
\r
1340 simple steps. First you need to get a user ID and password from qrz.com.
\r
1341 Simply go to the site and create one. Secondly you need to copy the file
\r
1342 /spider/perl/Internet.pm to /spider/local and alter it to match your user
\r
1343 ID and password. You also at this point need to set $allow=1 to complete
\r
1344 the setup. Many thanks to Fred Lloyd, the proprieter of
\r
1345 <htmlurl url="http://www.qrz.com" name="qrz.com"> for allowing this access.
\r
1347 <sect1>Connecting logging programs
\r
1350 There appear to be very few logging programs out there that support telnet
\r
1351 especially the popular ones like LogEQF, Turbolog etc. This can make it
\r
1352 difficult to connect to your own cluster!
\r
1353 The way to do it is to make the logging program think it has a TNC attached
\r
1354 to a com port on the logging PC and 'push' a linux login out to it.
\r
1355 This is achieved very simply by the use of <em>agetty</em>.
\r
1358 All that is required is to add a line in /etc/inittab to have the client
\r
1359 ready for a connection on the com port of your choice. Remember that in
\r
1360 Linux, the com ports start at ttyS0 for com1, ttyS1 for com2 etc.
\r
1363 c4:2345:respawn:/sbin/agetty -L 9600 ttyS1
\r
1367 Add this after the standard runlevel lines in /etc/inittab. The above
\r
1368 line works on ttyS1 (com2). Now as root, issue the command <em>telinit q</em>
\r
1369 and it should be ready for connection. All that is required is a 3 wire
\r
1370 serial lead (tx, rx and signal ground). Tell you logging program to use
\r
1371 8n1 at 9600 baud and you should see a Linux login prompt. Login as normal
\r
1372 and then telnet from there to the cluster.
\r
1374 <sect>Java Web applet
\r
1377 In the spider tree will be a directory <em>spider-web</em>. This is a
\r
1378 neat little java web applet that can be run from a website. The applet
\r
1379 must run on the same machine as the cluster. The included README file is
\r
1383 I should comment here that the applet is precompiled, that is, ready to go.
\r
1384 It was compiled using JDK1.3.1. If your version is earlier than this then it
\r
1385 may not work. Should that be the case you need to recompile or update your
\r
1386 JDK. To recompile do the following ...
\r
1389 cd /spider/spider-web
\r
1391 /usr/bin/javac spiderclient.java
\r
1395 I have used /usr/bin/javac as an example, your path to javac may be different.
\r
1400 Completely based on a clx web client written in Java by dl6dbh
\r
1401 (ftp://clx.muc.de/pub/clx/clx-java_10130001.tgz)
\r
1403 The webserver has to run on the same machine as your DxSpider software!
\r
1405 It is assumed that you have Java installed. You need JDK1.3.1 at least.
\r
1407 Installation instructions (Performed as root):
\r
1409 Put all the files in the spider-web directory into a newly created directory
\r
1410 under the DocumentRoot of your websever for instance 'client'. In my case
\r
1411 this is: /home/httpd/html/client/ although ymmv. For Suse the correct
\r
1412 path should be /usr/local/httpd/htdocs/client/ for example.
\r
1414 Move spider.cgi to the cgi-bin directory of your webserver, in my case that is
\r
1415 /home/httpd/cgi-bin/ although ymmv. For Suse the correct path should be
\r
1416 /usr/local/httpd/cgi-bin/ for example.
\r
1418 Change the permissions of the files to ensure they are correct, obviously you
\r
1419 will need to use the correct path the the files according to your system:
\r
1421 chmod 755 /home/httpd/html/cgi-bin/spider.cgi
\r
1422 chmod -R 755 /home/httpd/html/client/
\r
1424 By default the spider.cgi script should pick up your hostname (As long as this
\r
1425 is set correctly). If it does not or your hostname differs from the name that
\r
1426 you attach to the public address that you are using, then edit spider.cgi :
\r
1428 # Uncomment and set the hostname manually here if the above fails.
\r
1429 # $HOSTNAME = "gb7mbc.spoo.org" ;
\r
1432 'HOSTNAME' is the hostname of your cluster.
\r
1434 'PORT' is the portnumber that you use to connect to your DxSpider via
\r
1435 telnet (see Listeners.pm)
\r
1437 NOTE: If you can start the console but cannot connect to the cluster from it,
\r
1438 then it is possible that the machine you are on cannot resolve the hostname of
\r
1439 your cluster machine. If this is the case, you need to set your hostname
\r
1440 manually as above.
\r
1442 You also need to set the $NODECALL variable. This prints the name of your
\r
1443 choosing (probably your cluster callsign) on the html page.
\r
1445 You now can connect to Spider-Web via http://yourserver/cgi-bin/spider.cgi
\r
1451 From version 1.49 DXSpider has some additional security features. These
\r
1452 are not by any means meant to be exhaustive, however they do afford some
\r
1453 security against piracy. These two new features can be used independently
\r
1454 of each other or in concert to tighten the security.
\r
1456 <sect1>Registration
\r
1459 The basic principle of registration is simple. If a user is not registered
\r
1460 by the sysop, then they have read-only access to the cluster. The only
\r
1461 thing they can actually send is a talk or a message to the sysop. In
\r
1462 order for them to be able to spot, send announces or talks etc the sysop
\r
1463 must register them with the <em>set/register</em> command, like this ...
\r
1466 set/register g0vgs
\r
1469 The user g0vgs can now fully use the cluster. In order to enable
\r
1470 registration, you can issue the command ...
\r
1473 set/var $main::reqreg = 1
\r
1476 Any users that are not registered will now see the motd_nor file rather
\r
1477 than the motd file as discussed in the Information, files and useful
\r
1481 Entering this line at the prompt will only last for the time the cluster
\r
1482 is running of course and would not be present on a restart. To make the
\r
1483 change permanent, add the above line to /spider/scripts/startup. To
\r
1484 read more on the startup file, see the section on Information, files
\r
1485 and useful programs.
\r
1488 To unregister a user use <em>unset/register</em> and to show the list
\r
1489 of registered users, use the command <em>show/register</em>.
\r
1494 At the moment, passwords only affect users who login to a DXSpider
\r
1495 cluster node via telnet. If a user requires a password, they can
\r
1496 either set it themselves or have the sysop enter it for them by using
\r
1497 the <em>set/password</em> command. Any users who already have passwords,
\r
1498 such as remote sysops, will be asked for their passwords automatically
\r
1499 by the cluster. Using passwords in this way means that the user has a
\r
1500 choice on whether to have a password or not. To force the use of
\r
1501 passwords at login, issue the command ...
\r
1504 set/var $main::passwdreq = 1
\r
1507 at the cluster prompt. This can also be added to the /spider/scripts/startup
\r
1508 file as above to make the change permanent.
\r
1511 Of course, if you do this you will have to assign a password for each of
\r
1512 your users. If you were asking them to register, it is anticipated that
\r
1513 you would ask them to send you a message both to ask to be registered and
\r
1514 to give you the password they wish to use.
\r
1517 Should a user forget their password, it can be reset by the sysop by
\r
1518 first removing the existing password and then setting a new one like so ...
\r
1521 unset/password g0vgs
\r
1522 set/password g0vgs new_password
\r
1527 <sect1>CVS from a Linux platform
\r
1530 CVS stands for "Concurrent Versions System" and the CVS for DXSpider is held
\r
1531 at <htmlurl url="http://www.sourceforge.net" name="Sourceforge">. This means
\r
1532 that it is possible to update your DXSpider installation to the latest
\r
1533 sources by using a few simple commands. A graphical interface to CVS for
\r
1534 Windows is explained in the next section.
\r
1537 Please be aware that if you update your system using CVS, it is possible that
\r
1538 you could be running code that is very beta and not fully tested. There is
\r
1539 a possibility that it could be unstable.
\r
1542 I am of course assuming that you have a machine with both DXSpider and
\r
1543 Internet access running.
\r
1546 BEFORE YOU EVEN CONSIDER STARTING WITH THIS MAKE A BACKUP OF YOUR
\r
1547 ENTIRE SPIDER TREE!!
\r
1550 Assuming you are connected to the Internet, you need to login to the
\r
1551 CVS repository and then update your Spider source. There are several
\r
1552 steps which are listed below ...
\r
1555 First login as the user <em>sysop</em>. Next you need to connect to the CVS
\r
1556 repository. You do this with the command below ...
\r
1559 cvs -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login
\r
1562 You will get a password prompt. Simply hit return here and your machine should
\r
1563 return to a normal linux prompt.
\r
1566 What happens next depends on whether you have an existing installation that
\r
1567 you want to update with the latest and greatest or whether you just want
\r
1568 to see what is there and/or run it on a new machine for testing.
\r
1570 If you are installing Spider from CVS then change directory to /home/sysop
\r
1572 If you are wanting to update Spider then cd to /tmp
\r
1575 The next step will create a brand new 'spider' directory in your current
\r
1579 cvs -z3 -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider co spider
\r
1582 This command is all on one line.
\r
1585 Hopefully your screen should show you downloading files. The -z3 simply compresses
\r
1586 the download to improve speed.
\r
1587 When this has finished, you will have exactly the same as if you had untarred a full
\r
1588 tarball PLUS some extra directories and files that CVS needs to do the magic that
\r
1592 Now if you are doing a new installation, that's it. Carry on as if you have
\r
1593 just downloaded and untarred the lastest tarball.
\r
1596 If you want to upgrade your current installation then do this ...
\r
1599 tar cvfz /tmp/s.tgz spider
\r
1601 tar xvfzp /tmp/s.tgz
\r
1604 This is assuming you downloaded to the /tmp directory of course.
\r
1607 NOTE: the 'p' on the end of the 'xvfz' is IMPORTANT! It keeps the permissions
\r
1608 correct. YOU WERE LOGGED IN AS THE USER SYSOP WEREN'T YOU?????
\r
1610 Remember to recompile the C client (cd /spider/src; make)
\r
1613 At this point the files have been upgraded. You can (usually) restart the cluster
\r
1614 in your own time. However, if you attempt to use any new commands or features
\r
1615 expect it to be fatal! At least your cluster will have been restarted then so it
\r
1616 will be too late to worry about it!
\r
1619 Now the magic part! From now on when you want to update, simply connect to the
\r
1620 Internet and then, as the user <em>sysop</em> ...
\r
1627 and your files will be updated. As above, remember to recompile the "C" client
\r
1628 if it has been updated (CVS will tell you) and restart if any of the perl scripts
\r
1629 have been altered or added, again, CVS will tell you.
\r
1632 You will find any changes documented in the /spider/Changes file.
\r
1634 <sect1>CVS from a Windows platform
\r
1637 After the initial setup, an update to your DXSpider software is no more than a couple
\r
1638 of clicks away. This section is intended to explain and illustrate the use of the
\r
1639 WinCVS application to update your DXSpider software. The current stable version of
\r
1640 WinCVS is Ver. 1.2. You can get this software at:
\r
1642 <htmlurl url="http://prdownloads.sourceforge.net/cvsgui/WinCvs120.zip" name="http://prdownloads.sourceforge.net/cvsgui/WinCvs120.zip">
\r
1644 Pick your download mirror and then install WinCVS after the download is complete.
\r
1646 In this next section I have included a series of links to .jpg files to take advantage of the
\r
1647 picture and 1000 words equivalency. The .jpg files are in the C:\spider\html directory. If
\r
1648 someone using a Linux system is reading this section from boredom, the files are in
\r
1649 /home/sysop/spider/html. One aside, a Linux user can also get a copy of gcvs and do your updates
\r
1650 graphically as opposed to from the command line. The following descriptions are almost identical
\r
1651 between WinCvs and gcvs. The following screen shots have duplicate links, depending upon whether
\r
1652 you are viewing this information under the Windows or Linux operating system.
\r
1654 When WinCVS is installed, running, and you are connected to the internet, the initial screen looks like:
\r
1656 <htmlurl url="initial.jpg" name="initial.jpg">
\r
1658 If you want, you can also look at these .jpg files with another viewer that might provide some
\r
1659 better clarity to the image. On the left is the directory tree for your hard disk. Notice that
\r
1660 the spider directory has a gray highlight.
\r
1662 To start configuring WinCVS, click on Admin at the top of the screen and then Preferences. This
\r
1665 <htmlurl url="pref-gen.jpg" name="pref-gen.jpg">
\r
1667 In the top line for CVSROOT, enter:
\r
1669 anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login
\r
1674 "passwd" file on the cvs server
\r
1677 for Authentication on the General tab.
\r
1679 Next, move to the right to the Ports tab.
\r
1681 <htmlurl url="pref-ports.jpg" name="pref-ports.jpg">
\r
1683 In here, check the box on the second line down for the "pserver" port. Enter a port number of 2401.
\r
1685 Finally, go to the WinCvs tab all the way to the right.
\r
1687 <htmlurl url="pref-wincvs.jpg" name="pref-wincvs.jpg">
\r
1689 Enter Notepad as the viewer to open files. For the HOME folder, put "C:\spider" and click OK
\r
1690 because the configuration is now complete.
\r
1692 You are now ready to upgrade your copy of DXSpider. Click on the greyed Spider folder
\r
1693 shown in the directory tree on the left of the WinCVS display. Two things should happen. The Spider
\r
1694 folder will be selected and the greyed-out arrow located just below the word Query in the top line will
\r
1695 turn to solid green.
\r
1697 For anyone using gcvs under Linux, the green arrow is located on the extreme left of the display,
\r
1698 under the word File. A gcvs screen looks like:
\r
1700 <htmlurl url="gcvs.jpg" name="gcvs.jpg">
\r
1702 Click on the now green arrow to start the download process. An Update Settings box will be displayed
\r
1703 to which you can simply say OK.
\r
1705 <htmlurl url="update-OK.jpg" name="update-OK.jpg">
\r
1707 For future reference, the Update Settings box is the place where you can enter information to revert
\r
1708 to a prior version of DXSpider. Information on reverting to a Before Date is contained in the WinCVS
\r
1711 After a short period of time, a series of file names will scroll by in the lower pane of the WinCVS
\r
1712 window. Eventually you should see
\r
1714 *****CVS exited normally with code 0*****
\r
1717 appear in the lower pane. You're done. The updated files are in place ready for you to stop and then
\r
1718 restart your DXSpider. After the restart, you're running with the latest version of DXSpider.
\r
1720 <htmlurl url="completed.jpg" name="completed.jpg">
\r
1722 To paraphrase from the CVS section... Now the magic part! From now on when you want to update, simply
\r
1723 connect to the Internet and start WinCVS.
\r
1725 Click on the greyed-out Spider directory in the left screen
\r
1726 Click on the green down arrow
\r
1727 Click OK on the Update Settings dialog box
\r
1728 Restart your Spider software
\r
1731 <sect>The DXSpider command set
\r
1734 Below is a complete list of commands available from the cluster prompt.
\r
1735 Most maintenance tasks are automatic but there are some commands that are useful
\r
1736 for a sysop. These are listed below in alphabetical order. The number in
\r
1737 brackets following the command name is the permissions level needed to use
\r
1740 <sect1>accept/announce (0)
\r
1744 <bf>accept/announce [0-9] <pattern></bf> Set an accept filter
\r
1749 Create an 'accept this announce' line for a filter.
\r
1751 An accept filter line means that if the announce matches this filter it is
\r
1752 passed onto the user. See HELP FILTERS for more info. Please read this
\r
1753 to understand how filters work - it will save a lot of grief later on.
\r
1755 You can use any of the following things in this line:-
\r
1758 info <string> eg: iota or qsl
\r
1759 by <prefixes> eg: G,M,2
\r
1761 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
\r
1762 origin_itu <numbers>
\r
1763 origin_zone <numbers>
\r
1767 channel <prefixes>
\r
1768 wx 1 filter WX announces
\r
1769 dest <prefixes> eg: 6MUK,WDX (distros)
\r
1776 acc/ann 2 by_zone 14,15,16
\r
1777 (this could be all on one line: acc/ann dest 6MUK or by_zone 14,15,16)
\r
1786 This filter would only allow announces that were posted buy UK stations.
\r
1787 You can use the tag 'all' to accept everything eg:
\r
1793 but this probably for advanced users...
\r
1795 <sect1>accept/announce (extended for sysops) (8)
\r
1799 <bf>accept/announce <call> [input] [0-9]<pattern></bf> Announce filter sysop version
\r
1803 This version allows a sysop to set a filter for a callsign as well as the
\r
1804 default for nodes and users eg:-
\r
1807 accept/ann by G,M,2
\r
1808 accept/ann input node_default by G,M,2
\r
1809 accept/ann user_default by G,M,2
\r
1812 <sect1>accept/route (8)
\r
1816 <bf>accept/route <call> [0-9] <pattern></bf> Set an 'accept' filter line for routing
\r
1820 Create an 'accept this routing PC Protocol' line for a filter.
\r
1823 An accept filter line means that if a PC16/17/19/21/24/41/50 matches this filter
\r
1824 it is passed thru that interface. See HELP FILTERING for more info. Please read this
\r
1825 to understand how filters work - it will save a lot of grief later on.
\r
1828 You can use any of the following things in this line:-
\r
1831 call <prefixes> the callsign of the thingy
\r
1832 call_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
\r
1833 call_itu <numbers>
\r
1834 call_zone <numbers>
\r
1835 origin <prefixes> really the interface it came in on
\r
1836 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
\r
1837 origin_itu <numbers>
\r
1838 origin_zone <numbers>
\r
1845 acc/route gb7djk call_dxcc 61,38 (send only UK+EIRE nodes)
\r
1846 acc/route gb7djk call gb7djk (equiv to SET/ISOLATE)
\r
1850 You can use the tag 'all' to accept everything eg:
\r
1856 <sect1>accept/spots (0)
\r
1860 <bf>accept/spots [0-9] <pattern></bf> Set an accept filter
\r
1865 Create an 'accept this spot' line for a filter.
\r
1868 An accept filter line means that if the spot matches this filter it is
\r
1869 passed onto the user. See HELP FILTERS for more info. Please read this
\r
1870 to understand how filters work - it will save a lot of grief later on.
\r
1872 Please read the following section carefully. Though it looks similar,
\r
1873 reformatting, corrections, and hopefully clarifications have been added.
\r
1875 You can use any of the following things in this line:-
\r
1878 Filters for the station being spotted:
\r
1879 call <letters of the prefix, but NOT country inclusive>
\r
1880 call G --> G1AAA, GJ2BBB, GU3CCC, etc will be spotted
\r
1881 call K --> K1XX, K1XXX will be spotted
\r
1882 W1XX, W1XXX will NOT be spotted
\r
1883 call PA --> PA3EZL will be spotted
\r
1884 PB2FG will NOT be spotted
\r
1886 call_dxcc <numbers or prefixes>
\r
1887 call_dxcc G --> G1AAA will be spotted
\r
1888 GU1AAA will NOT be spotted (different country)
\r
1889 call_dxcc K --> K1XX, W1XX will be spotted (same country)
\r
1890 call_dxcc 139 --> PA3EZL and PB2FG will be spotted
\r
1892 call_itu <numbers>
\r
1893 call_zone <numbers>
\r
1895 Filters for the callsign of the station doing the spotting:
\r
1896 by <letters of the prefix, but NOT country inclusive>
\r
1897 by G --> spots from G1AAA, GJ2BBB, GU3CCC, etc will be spotted
\r
1898 by K --> spots from K1XX, K1XXX will be spotted
\r
1899 spots from W1XX, W1XXX will NOT be spotted
\r
1901 by_dxcc <numbers or prefixes>
\r
1902 by_dxcc G --> spots from G1AAA will be spotted
\r
1903 spots from GU1AAA will NOT be spotted (different
\r
1905 by_dxcc K --> spots from K1XX, W1XX will be spotted (same country)
\r
1906 by_dxcc 139 --> spots from PA3EZL or PB2FG will be spotted
\r
1911 Filters for the callsign of the "node" doing the spotting:
\r
1912 origin <letters of the prefix, but NOT country inclusive>
\r
1913 origin K --> spots from a node starting with K will be spotted
\r
1914 spots from a node starting with KK will NOT be spotted
\r
1915 spots from a node starting with W will NOT be spotted
\r
1917 Filters for the callsign of the connected node or user (channel) doing the spotting:
\r
1918 channel <prefixes>
\r
1919 channel W1HR --> spots from the connected node W1HR will be spotted
\r
1920 channel K1QX --> spots from the connected user K1QX will be spotted
\r
1922 info <string> eg: iota or qsl
\r
1923 freq <range> eg: 0/30000 or hf or hf/cw or 6m,4m,2m
\r
1924 on <range> same as 'freq'
\r
1929 For frequencies, you can use any of the band names defined in
\r
1930 SHOW/BANDS and you can use a subband name like: cw, rtty, data, ssb -
\r
1931 thus: hf/ssb. You can also just have a simple range like: 0/30000 -
\r
1932 this is more efficient than saying simply: freq HF (but don't get
\r
1933 too hung up about that)
\r
1938 acc/spot 1 on hf/cw
\r
1939 acc/spot 2 on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
\r
1942 You can use the tag 'all' to accept everything, eg:
\r
1948 but this probably for advanced users...
\r
1950 <sect1>accept/spots (extended for sysops) (8)
\r
1954 <bf>accept/spots <call> [input] [0-9] <pattern></bf> Spot filter sysop version
\r
1958 This version allows a sysop to set a filter for a callsign as well as the
\r
1959 default for nodes and users eg:-
\r
1962 accept/spot db0sue-7 1 by_zone 14,15,16
\r
1963 accept/spot node_default all
\r
1964 set/hops node_default 10
\r
1966 accept/spot user_default by G,M,2
\r
1969 <sect1>accept/wcy (0)
\r
1973 <bf>accept/wcy [0-9] <pattern></bf> set an accept WCY filter
\r
1977 It is unlikely that you will want to do this, but if you do then you can
\r
1978 filter on the following fields:-
\r
1981 by <prefixes> eg: G,M,2
\r
1983 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
\r
1984 origin_itu <numbers>
\r
1985 origin_zone <numbers>
\r
1989 channel <prefixes>
\r
1993 There are no examples because WCY Broadcasts only come from one place and
\r
1994 you either want them or not (see UNSET/WCY if you don't want them).
\r
1996 This command is really provided for future use.
\r
1998 See HELP FILTER for information.
\r
2000 <sect1>accept/wcy (extended for sysops) (8)
\r
2004 <bf>accept/wcy <call> [input] [0-9] <pattern></bf>
\r
2005 WCY filter sysop version
\r
2009 This version allows a sysop to set a filter for a callsign as well as the
\r
2010 default for nodes and users eg:-
\r
2013 accept/wcy node_default all
\r
2014 set/hops node_default 10
\r
2017 <sect1>accept/wwv (0)
\r
2021 <bf>accept/wwv [0-9] <pattern></bf> Set an accept WWV filter
\r
2025 It is unlikely that you will want to do this, but if you do then you can
\r
2026 filter on the following fields:-
\r
2029 by <prefixes> eg: G,M,2
\r
2031 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
\r
2032 origin_itu <numbers>
\r
2033 origin_zone <numbers>
\r
2037 channel <prefixes>
\r
2043 accept/wwv by_zone 4
\r
2046 is probably the only useful thing to do (which will only show WWV broadcasts
\r
2047 by stations in the US).
\r
2049 See HELP FILTER for information.
\r
2051 <sect1>accept/wwv (extended for sysops) (8)
\r
2055 <bf>accept/wwv <call> [input] [0-9] <pattern></bf>
\r
2056 WWV filter sysop version
\r
2060 This version allows a sysop to set a filter for a callsign as well as the
\r
2061 default for nodes and users eg:-
\r
2064 accept/wwv db0sue-7 1 by_zone 4
\r
2065 accept/wwv node_default all
\r
2066 set/hops node_default 10
\r
2068 accept/wwv user_default by W,K
\r
2071 <sect1>announce (0)
\r
2075 <bf>announce <text></bf> Send an announcement to local users
\r
2079 Send an announcement to LOCAL users only, where <text> is the text
\r
2080 of the announcement you wish to broadcast. If you do not wish to receive
\r
2081 announces, use the <em>set/noannounce</em> command. Any announces made by
\r
2082 a sysop will override set/noannounce.
\r
2084 <sect1>announce full (0)
\r
2088 <bf>announce full <text></bf> Send an announcement cluster wide
\r
2092 This command will send your announcement across the whole cluster
\r
2096 <sect1>announce sysop (5)
\r
2100 <bf>announce sysop <text></bf>
\r
2104 Send an announcement to Sysops only
\r
2106 <sect1>apropos (0)
\r
2110 <bf>apropos <string></bf> Search the help database
\r
2114 Search the help database for <string> (it isn't case sensitive),
\r
2115 and print the names of all the commands that may be relevant.
\r
2121 <bf>bye</bf> Exit from the cluster
\r
2125 This will disconnect you from the cluster
\r
2127 <sect1>catchup (5)
\r
2131 <bf>catchup <node_call> All|[<msgno> ...]</bf>
\r
2132 Mark a message as sent
\r
2136 When you send messages the fact that you have forwarded it to another node
\r
2137 is remembered so that it isn't sent again. When you have a new partner
\r
2138 node and you add their callsign to your /spider/msg/forward.pl file, all
\r
2139 outstanding non-private messages will be forwarded to them. This may well
\r
2140 be ALL the non-private messages. You can prevent this by using these
\r
2144 catchup GB7DJK all
\r
2145 catchup GB7DJK 300 301 302 303 500-510
\r
2148 and to undo what you have just done:-
\r
2151 uncatchup GB7DJK all
\r
2152 uncatchup GB7DJK 300 301 302 303 500-510
\r
2155 which will arrange for them to be forward candidates again.
\r
2157 Order is not important.
\r
2159 <sect1>clear/announce (8)
\r
2163 <bf>clear/announce [input] <callsign> [0-9|all]</bf> Clear an announce filter line
\r
2167 A sysop can clear an input or normal output filter for a user or the
\r
2168 node_default or user_default.
\r
2170 <sect1>clear/route (8)
\r
2174 <bf>clear/route [input] ^lt;callsign> [0-9|all]</bf> Clear a route filter line
\r
2178 This command allows you to clear (remove) a line in a route filter or to
\r
2179 remove the whole filter.
\r
2181 see CLEAR/SPOTS for a more detailed explanation.
\r
2183 A sysop can clear an input or normal output filter for a user or the
\r
2184 node_default or user_default.
\r
2186 <sect1>clear/spots (0)
\r
2190 <bf>clear/spots [1|all]</bf> Clear a spot filter line
\r
2194 This command allows you to clear (remove) a line in a spot filter or to
\r
2195 remove the whole filter.
\r
2197 If you have a filter:-
\r
2200 acc/spot 1 on hf/cw
\r
2201 acc/spot 2 on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
\r
2210 you will be left with:-
\r
2213 acc/spot 2 on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
\r
2222 the filter will be completely removed.
\r
2224 <sect1>clear/spots (extended for sysops) (8)
\r
2228 <bf>clear/spots [input] <callsign> [0-9|all]</bf> Clear a spot filter line
\r
2232 A sysop can clear an input or normal output filter for a user or the
\r
2233 node_default or user_default.
\r
2235 <sect1>clear/wcy (0)
\r
2239 <bf>clear/wcy [1|all]</bf> Clear a WCY filter line
\r
2243 This command allows you to clear (remove) a line in a WCY filter or to
\r
2244 remove the whole filter.
\r
2246 see CLEAR/SPOTS for a more detailed explanation.
\r
2248 <sect1>clear/wcy (extended for sysops) (8)
\r
2252 <bf>clear/wcy [input] <callsign> [0-9|all]</bf> Clear a WCY filter line
\r
2256 A sysop can clear an input or normal output filter for a user or the
\r
2257 node_default or user_default.
\r
2259 <sect1>clear/wwv (0)
\r
2263 <bf>clear/wwv [1|all]</bf> Clear a WWV filter line
\r
2267 This command allows you to clear (remove) a line in a WWV filter or to
\r
2268 remove the whole filter.
\r
2270 see CLEAR/SPOTS for a more detailed explanation.
\r
2272 <sect1>clear/wwv (extended for sysops) (8)
\r
2276 <bf>clear/wwv [input] <callsign> [0-9|all]</bf> Clear a WWV filter line
\r
2280 A sysop can clear an input or normal output filter for a user or the
\r
2281 node_default or user_default.
\r
2283 <sect1>connect (5)
\r
2287 <bf>connect <callsign></bf> Start a connection to another DX Cluster
\r
2291 Start a connection process that will culminate in a new connection to the
\r
2292 DX cluster <callsign>. This process creates a new 'client' process which will
\r
2293 use the script in /spider/connect/<callsign> to effect the 'chat' exchange
\r
2294 necessary to traverse the network(s) to logon to the cluster <callsign>.
\r
2296 <sect1>dbavail (0)
\r
2300 <bf>dbavail</bf> Show a list of all the databases in the system
\r
2304 The title says it all really, this command lists all the databases defined
\r
2305 in the system. It is also aliased to SHOW/COMMAND.
\r
2307 <sect1>dbcreate (9)
\r
2311 <bf>dbcreate <name></bf> Create a database entry<newline>
\r
2312 <bf>dbcreate <name> chain <name> [<name>..]</bf> Create a
\r
2313 chained database entry<newline>
\r
2314 <bf>dbcreate <name> remote <node></bf> Create a remote database
\r
2319 DBCREATE allows you to define a database in the system. It doesn't actually
\r
2320 create anything, just defines it.
\r
2322 The databases that are created are simple DB_File hash databases, they are
\r
2323 therefore already 'indexed'.
\r
2325 You can define a local database with the first form of the command eg:
\r
2329 You can also chain databases with the addition of the 'chain' keyword.
\r
2330 This will search each database one after the other. A typical example
\r
2333 DBCREATE sdx_qsl chain sql_ad
\r
2335 No checking is done to see if the any of the chained databases exist, in
\r
2336 fact it is usually better to do the above statement first then do each of
\r
2337 the chained databases.
\r
2339 Databases can exist offsite. To define a database that lives on another
\r
2342 DBCREATE buckmaster remote gb7dxc
\r
2344 Remote databases cannot be chained; however, the last database in a
\r
2345 a chain can be a remote database eg:
\r
2347 DBCREATE qsl chain gb7dxc
\r
2349 To see what databases have been defined do:
\r
2351 DBAVAIL (or it will have been aliased to SHOW/COMMAND)
\r
2353 It would be normal for you to add an entry into your local Aliases file
\r
2354 to allow people to use the 'SHOW/<dbname>' style syntax. So you would
\r
2355 need to add a line like:-
\r
2361 '^sh\w*/buc', 'dbshow buckmaster', 'dbshow',
\r
2371 to work as they may be used to.
\r
2373 See DBIMPORT for the importing of existing AK1A format data to databases.
\r
2374 See DBSHOW for generic database enquiry
\r
2376 <sect1>dbimport (9)
\r
2380 <bf>dbimport <dbname></bf> Import AK1A data into a database
\r
2384 If you want to import or update data in bulk to a database you can use
\r
2385 this command. It will either create or update entries into an existing
\r
2386 database. For example:-
\r
2388 DBIMPORT oblast /tmp/OBLAST.FUL
\r
2390 will import the standard OBLAST database that comes with AK1A into the
\r
2391 oblast database held locally.
\r
2393 <sect1>dbremove (9)
\r
2397 <bf>dbremove <dbname></bf> Delete a database
\r
2401 DBREMOVE will completely remove a database entry and also delete any data
\r
2402 file that is associated with it.
\r
2404 There is no warning, no comeback, no safety net.
\r
2410 will remove the oblast database from the system and it will also remove
\r
2411 the associated datafile.
\r
2415 There is no warning, no comeback, no safety net.
\r
2417 You have been warned.
\r
2423 <bf>dbshow <dbname> <key></bf> Display an entry, if it exists,
\r
2428 This is the generic user interface to the database to the database system.
\r
2429 It is expected that the sysop will add an entry to the local Aliases file
\r
2430 so that users can use the more familiar AK1A style of enquiry such as:
\r
2436 but if he hasn't and the database really does exist (use DBAVAIL or
\r
2437 SHOW/COMMAND to find out) you can do the same thing with:
\r
2448 <bf>debug</bf> Set the cluster program into debug mode
\r
2452 Executing this command will only have an effect if you are running the cluster
\r
2453 in debug mode i.e.
\r
2456 perl -d cluster.pl
\r
2459 It will interrupt the cluster just after the debug command has finished.
\r
2461 <sect1>delete/user (9)
\r
2465 <bf>delete/user <callsign></bf> Delete a user from the User Database
\r
2469 This command will completely remove a one or more users from the database.
\r
2471 There is NO SECOND CHANCE.
\r
2473 It goes without saying that you should use this command CAREFULLY!
\r
2475 <sect1>demonstrate (9)
\r
2479 <bf>demonstrate <call> <command></bf> Demonstrate a command to another user
\r
2483 This command is provided so that sysops can demonstrate commands to
\r
2484 other users. It runs a command as though that user had typed it in and
\r
2485 then sends the output to that user, together with the command that
\r
2489 DEMO g7brn sh/dx iota oc209
\r
2490 DEMO g1tlh set/here
\r
2493 Note that this command is similar to SPOOF and will have the same side
\r
2494 effects. Commands are run at the privilege of the user which is being
\r
2497 <sect1>directory (0)
\r
2501 <bf>directory</bf> List messages<newline>
\r
2502 <bf>directory all</bf> List all messages<newline>
\r
2503 <bf>directory own</bf> List your own messages<newline>
\r
2504 <bf>directory new</bf> List all new messages<newline>
\r
2505 <bf>directory to <call></bf> List all messages to <call><newline>
\r
2506 <bf>directory from <call></bf> List all messages from <call><newline>
\r
2507 <bf>directory subject <string></bf> List all messages with <string>
\r
2508 in subject<newline>
\r
2509 <bf>directory <nn></bf> List last <nn> messages<newline>
\r
2510 <bf>directory <from>-<to></bf> List messages <from> message <to> message <newline>
\r
2514 List the messages in the messages directory.
\r
2516 If there is a 'p' one space after the message number then it is a
\r
2517 personal message. If there is a '-' between the message number and the
\r
2518 'p' then this indicates that the message has been read.
\r
2520 You can use shell escape characters such as '*' and '?' in the <call>
\r
2523 You can combine some of the various directory commands together eg:-
\r
2528 DIR SUBJECT IOTA 200-250
\r
2531 You can abbreviate all the commands to one letter and use ak1a syntax:-
\r
2535 DIR/S QSL 10-100 5
\r
2539 <sect1>directory (extended for sysops) (5)
\r
2542 Works just like the user command except that sysops can see ALL messages.
\r
2544 <sect1>disconnect (8)
\r
2548 <bf>disconnect <call> [<call> ...]</bf> Disconnect a user or node
\r
2552 Disconnect any <call> connected locally
\r
2558 <bf>dx [by <call>] <freq> <call> <remarks></bf> Send a DX spot
\r
2562 This is how you send a DX Spot to other users. You can, in fact, now
\r
2563 enter the <freq> and the <call> either way round.
\r
2571 will all give the same result. You can add some remarks to the end
\r
2572 of the command and they will be added to the spot.
\r
2575 DX FR0G 144600 this is a test
\r
2578 You can credit someone else by saying:-
\r
2581 DX by G1TLH FR0G 144.600 he isn't on the cluster
\r
2584 The <freq> is compared against the available bands set up in the
\r
2585 cluster. See SHOW/BANDS for more information.
\r
2591 <bf>export <msgno> <filename></bf> Export a message to a file
\r
2595 Export a message to a file. This command can only be executed on a local
\r
2596 console with a fully privileged user. The file produced will be in a form
\r
2597 ready to be imported back into the cluster by placing it in the import
\r
2598 directory (/spider/msg/import).
\r
2600 This command cannot overwrite an existing file. This is to provide some
\r
2601 measure of security. Any files written will owned by the same user as the
\r
2602 main cluster, otherwise you can put the new files anywhere the cluster can
\r
2603 access. For example:-
\r
2605 EXPORT 2345 /tmp/a
\r
2607 <sect1>export_users (9)
\r
2611 <bf>export_users [<filename>]</bf> Export the users database to ascii
\r
2615 Export the users database to a file in ascii format. If no filename
\r
2616 is given then it will export the file to /spider/data/user_asc.
\r
2618 If the file already exists it will be renamed to <filename>.o. In fact
\r
2619 up to 5 generations of the file can be kept each one with an extra 'o' on the
\r
2622 BE WARNED: this will write to any file you have write access to. No check is
\r
2623 made on the filename (if any) that you specify.
\r
2625 <sect1>filtering (0)
\r
2629 <bf>filtering</bf> Filtering things in DXSpider
\r
2633 There are a number of things you can filter in the DXSpider system. They
\r
2634 all use the same general mechanism.
\r
2636 In general terms you can create a 'reject' or an 'accept' filter which
\r
2637 can have up to 10 lines in it. You do this using, for example:-
\r
2639 accept/spots .....
\r
2640 reject/spots .....
\r
2642 where ..... are the specific commands for that type of filter. There
\r
2643 are filters for spots, wwv, announce, wcy and (for sysops)
\r
2644 connects. See each different accept or reject command reference for
\r
2647 There is also a command to clear out one or more lines in a filter and
\r
2648 one to show you what you have set. They are:-
\r
2657 There is clear/xxxx command for each type of filter.
\r
2659 For now we are going to use spots for the examples, but you can apply
\r
2660 the principles to all types of filter.
\r
2662 There are two main types of filter 'accept' or 'reject'; which you use
\r
2663 depends entirely on how you look at the world and what is least
\r
2664 writing to achieve what you want. Each filter has 10 lines (of any
\r
2665 length) which are tried in order. If a line matches then the action
\r
2666 you have specified is taken (ie reject means ignore it and accept
\r
2669 The important thing to remember is that if you specify a 'reject'
\r
2670 filter (all the lines in it say 'reject/spots' (for instance) then if
\r
2671 a spot comes in that doesn't match any of the lines then you will get
\r
2672 it BUT if you specify an 'accept' filter then any spots that don't
\r
2673 match are dumped. For example if I have a one line accept filter:-
\r
2675 accept/spots on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
\r
2677 then automatically you will ONLY get VHF spots from or to CQ zones 14
\r
2678 15 and 16. If you set a reject filter like:
\r
2680 reject/spots on hf/cw
\r
2682 Then you will get everything EXCEPT HF CW spots, If you am interested in IOTA
\r
2683 and will work it even on CW then you could say:-
\r
2685 reject/spots on hf/cw and not info iota
\r
2687 But in that case you might only be interested in iota and say:-
\r
2689 accept/spots not on hf/cw or info iota
\r
2691 which is exactly the same. You should choose one or the other until
\r
2692 you are confortable with the way it works. Yes, you can mix them
\r
2693 (actually you can have an accept AND a reject on the same line) but
\r
2694 don't try this at home until you can analyse the results that you get
\r
2695 without ringing up the sysop for help.
\r
2697 You can arrange your filter lines into logical units, either for your
\r
2698 own understanding or simply convenience. I have one set frequently:-
\r
2700 reject/spots 1 on hf/cw
\r
2701 reject/spots 2 on 50000/1400000 not (by_zone 14,15,16 or call_zone 14,15,16)
\r
2703 What this does is to ignore all HF CW spots (being a class B I can't
\r
2704 read any CW and couldn't possibly be interested in HF :-) and also
\r
2705 rejects any spots on VHF which don't either originate or spot someone
\r
2708 This is an exmaple where you would use the line number (1 and 2 in
\r
2709 this case), if you leave the digit out, the system assumes '1'. Digits
\r
2710 '0'-'9' are available.
\r
2712 You can leave the word 'and' out if you want, it is implied. You can
\r
2713 use any number of brackets to make the 'expression' as you want
\r
2714 it. There are things called precedence rules working here which mean
\r
2715 that you will NEED brackets in a situation like line 2 because,
\r
2716 without it, will assume:-
\r
2718 (on 50000/1400000 and by_zone 14,15,16) or call_zone 14,15,16
\r
2720 annoying, but that is the way it is. If you use OR - use
\r
2721 brackets. Whilst we are here CASE is not important. 'And BY_Zone' is
\r
2722 just 'and by_zone'.
\r
2724 If you want to alter your filter you can just redefine one or more
\r
2725 lines of it or clear out one line. For example:-
\r
2727 reject/spots 1 on hf/ssb
\r
2733 To remove the filter in its entirty:-
\r
2737 There are similar CLEAR commands for the other filters:-
\r
2745 Once you are happy with the results you get, you may like to experiment.
\r
2747 my example that filters hf/cw spots and accepts vhf/uhf spots from EU
\r
2748 can be written with a mixed filter, eg:
\r
2751 acc/spot on 0/30000
\r
2752 acc/spot 2 on 50000/1400000 and (by_zone 14,15,16 or call_zone 14,15,16)
\r
2754 each filter slot actually has a 'reject' slot and an 'accept'
\r
2755 slot. The reject slot is executed BEFORE the accept slot.
\r
2757 It was mentioned earlier that after a reject test that doesn't match,
\r
2758 the default for following tests is 'accept', the reverse is true for
\r
2759 'accept'. In the example what happens is that the reject is executed
\r
2760 first, any non hf/cw spot is passed to the accept line, which lets
\r
2761 thru everything else on HF.
\r
2763 The next filter line lets through just VHF/UHF spots from EU.
\r
2765 <sect1>forward/latlong (8)
\r
2769 <bf>forward/latlong <node_call></bf> Send latitude and longitude
\r
2770 information to another cluster
\r
2774 This command sends all the latitude and longitude information that your
\r
2775 cluster is holding against callsigns. One advantage of recieving this
\r
2776 information is that more locator information is held by you. This
\r
2777 means that more locators are given on the DX line assuming you have
\r
2778 <em>set/dxgrid</em> enabled. This could be a LOT of information though, so
\r
2779 it is not recommended on slow links.
\r
2781 <sect1>forward/opername (1)
\r
2785 <bf>forward/opername <call></bf> Send out information on this <call>
\r
2790 This command sends out any information held in the user file which can
\r
2791 be broadcast in PC41 protocol packets. This information is Name, QTH, Location
\r
2792 and Homenode. PC41s are only sent for the information that is available.
\r
2798 <bf>help <cmd></bf> Get help on a command
\r
2802 All commands can be abbreviated, so SHOW/DX can be abbreviated
\r
2803 to SH/DX, ANNOUNCE can be shortened to AN and so on.
\r
2805 Look at the APROPOS <string> command which will search the help database
\r
2806 for the <string> you specify and give you a list of likely commands
\r
2807 to look at with HELP.
\r
2813 <bf>init <node call></bf> Re-initialise a link to an AK1A compatible node
\r
2817 This command attempts to re-initialise a link to a (usually) AK1A node
\r
2818 that has got confused, usually by a protocol loop of some kind. It may
\r
2819 work - but you usually will be better off simply disconnecting it (or
\r
2820 better, if it is a real AK1A node, doing an RCMD <node> DISC/F <your
\r
2823 Best of luck - you will need it.
\r
2829 <bf>kill <msgno> [<msgno> ..]</bf> Delete a message
\r
2830 from the local system
\r
2834 Delete a message from the local system. You will only be able to
\r
2835 delete messages that you have originated or been sent (unless you are
\r
2842 <bf>kill <msgno> [<msgno> ...]</bf> Remove or erase a message from
\r
2843 the system<newline>
\r
2844 <bf>kill from <call></bf> Remove all messages from a callsign<newline>
\r
2845 <bf>kill to <call></bf> Remove all messages to a callsign<newline>
\r
2849 You can get rid of any message to or originating from your callsign using
\r
2850 this command. You can remove more than one message at a time.
\r
2852 As a sysop you can kill any message on the system.
\r
2854 <sect1>kill full (5)
\r
2858 <bf>kill full <msgno> [<msgno>]</bf> Delete a message from the
\r
2863 Delete a message (usually a 'bulletin') from the whole cluster system.
\r
2865 This uses the subject field, so any messages that have exactly the same subject
\r
2866 will be deleted. Beware!
\r
2868 <sect1>kill/expunge (6)
\r
2872 <bf>kill/expunge <msgno> [<msgno>..]</bf>Expunge a message
\r
2876 Deleting a message using the normal KILL commands only marks that message
\r
2877 for deletion. The actual deletion only happens later (usually two days later).
\r
2879 The KILL EXPUNGE command causes the message to be truly deleted more or less
\r
2882 It otherwise is used in the same way as the KILL command.
\r
2889 <bf>links</bf> Show which nodes are physically connected
\r
2893 This is a quick listing that shows which links are connected and
\r
2894 some information about them. See WHO for a list of all connections.
\r
2897 <sect1>load/aliases (9)
\r
2901 <bf>load/aliases</bf> Reload the command alias table
\r
2905 Reload the /spider/cmd/Aliases file after you have editted it. You will need to
\r
2906 do this if you change this file whilst the cluster is running in order for the
\r
2907 changes to take effect.
\r
2909 <sect1>load/badmsg (9)
\r
2913 <bf>load/badmsg</bf> Reload the bad message table
\r
2917 Reload the /spider/msg/badmsg.pl file if you have changed it manually whilst
\r
2918 the cluster is running. This table contains a number of perl regular
\r
2919 expressions which are searched for in the fields targetted of each message.
\r
2920 If any of them match then that message is immediately deleted on receipt.
\r
2922 <sect1>load/badwords (9)
\r
2926 <bf>load/badwords</bf> Reload the bad words table
\r
2930 Reload the /spider/data/badwords file if you have changed it manually whilst
\r
2931 the cluster is running. This file contains a list of words which, if found
\r
2932 on certain text portions of PC protocol, will cause those protocol frames
\r
2933 to be rejected. It will all put out a message if any of these words are
\r
2934 used on the announce, dx and talk commands. The words can be one or
\r
2935 more on a line, lines starting with '#' are ignored.
\r
2937 <sect1>load/bands (9)
\r
2941 <bf>load/bands</bf> Reload the band limits table
\r
2945 Reload the /spider/data/bands.pl file if you have changed it manually whilst
\r
2946 the cluster is running.
\r
2948 <sect1>load/cmd_cache (9)
\r
2952 <bf>load/cmd_cache</bf> Reload the automatic command cache
\r
2956 Normally, if you change a command file in the cmd or local_cmd tree it will
\r
2957 automatially be picked up by the cluster program. Sometimes it can get confused
\r
2958 if you are doing a lot of moving commands about or delete a command in the
\r
2959 local_cmd tree and want to use the normal one again. Execute this command to
\r
2960 reset everything back to the state it was just after a cluster restart.
\r
2962 <sect1>load/forward (9)
\r
2966 <bf>load/forward</bf> Reload the msg forwarding routing table
\r
2969 Reload the /spider/msg/forward.pl file if you have changed it
\r
2970 manually whilst the cluster is running.
\r
2972 <sect1>load/messages (9)
\r
2976 <bf>load/messages</bf> Reload the system messages file
\r
2980 If you change the /spider/perl/Messages file (usually whilst fiddling/writing ne
\r
2981 commands) you can have them take effect during a cluster session by executing this
\r
2982 command. You need to do this if get something like :-
\r
2984 unknown message 'xxxx' in lang 'en'
\r
2986 <sect1>load/prefixes (9)
\r
2990 <bf>load/prefixes</bf> Reload the prefix table
\r
2994 Reload the /spider/data/prefix_data.pl file if you have changed it manually
\r
2995 whilst the cluster is running.
\r
3001 <bf>merge <node> [<no spots>/<no wwv>]</bf> Ask for the
\r
3002 latest spots and WWV
\r
3006 MERGE allows you to bring your spot and wwv database up to date. By default
\r
3007 it will request the last 10 spots and 5 WWVs from the node you select. The
\r
3008 node must be connected locally.
\r
3010 You can request any number of spots or wwv and although they will be appended
\r
3011 to your databases they will not duplicate any that have recently been added
\r
3012 (the last 2 days for spots and last month for WWV data).
\r
3018 <bf>msg <cmd> <msgno> [data ...]</bf> Alter various message
\r
3023 Alter message parameters like To, From, Subject, whether private or bulletin
\r
3024 or return receipt (RR) is required or whether to keep this message from timing
\r
3028 MSG TO <msgno> <call> - change TO callsign to <call>
\r
3029 MSG FRom <msgno> <call> - change FROM callsign to <call>
\r
3030 MSG PRrivate <msgno> - set private flag
\r
3031 MSG NOPRrivate <msgno> - unset private flag
\r
3032 MSG RR <msgno> - set RR flag
\r
3033 MSG NORR <msgno> - unset RR flag
\r
3034 MSG KEep <msgno> - set the keep flag (message won't be deleted ever)
\r
3035 MSG NOKEep <msgno> - unset the keep flag
\r
3036 MSG SUbject <msgno> <new> - change the subject to <new>
\r
3037 MSG WAittime <msgno> - remove any waitting time for this message
\r
3038 MSG NOREad <msgno> - mark message as unread
\r
3039 MSG REad <msgno> - mark message as read
\r
3040 MSG QUeue - queue any outstanding bulletins
\r
3041 MSG QUeue 1 - queue any outstanding private messages
\r
3044 You can look at the status of a message by using:-
\r
3046 STAT/MSG <msgno>
\r
3048 This will display more information on the message than DIR does.
\r
3054 <bf>pc <call> <text></bf> Send text (eg PC Protocol) to <call>
\r
3058 Send some arbitrary text to a locally connected callsign. No processing is done on
\r
3059 the text. This command allows you to send PC Protocol to unstick things if problems
\r
3060 arise (messages get stuck etc). eg:-
\r
3062 pc gb7djk PC33^GB7TLH^GB7DJK^400^
\r
3064 You can also use in the same way as a talk command to a connected user but
\r
3065 without any processing, added of "from <blah> to <blah>" or whatever.
\r
3067 pc G1TLH Try doing that properly!!!
\r
3073 <bf>ping <node></bf> Check the link quality between nodes
\r
3077 his command allows you to send a frame to another cluster node on
\r
3078 the network and get a return frame. The time it takes to do this
\r
3079 is a good indication of the quality of the link. The actual time
\r
3080 it takes is output to the console in seconds.
\r
3081 Any visible cluster node can be PINGed.
\r
3088 <bf>rcmd <node call> <cmd></bf> Send a command to another DX cluster
\r
3092 This command allows you to send nearly any command to another DX Cluster
\r
3093 node that is connected to the system.
\r
3095 Whether you get any output is dependant on a) whether the other system knows
\r
3096 that the node callsign of this cluster is in fact a node b) whether the
\r
3097 other system is allowing RCMDs from this node and c) whether you have
\r
3098 permission to send this command at all.
\r
3104 <bf>read</bf> Read the next unread personal message addressed to you<newline>
\r
3105 <bf>read <msgno></bf> Read the specified message<newline>
\r
3109 You can read any messages that are sent as 'non-personal' and also any
\r
3110 message either sent by or sent to your callsign.
\r
3113 <sect1>read (extended for sysops) (5)
\r
3117 <bf>read <msgno></bf> Read a message on the system
\r
3121 As a sysop you may read any message on the system
\r
3123 <sect1>reject/announce
\r
3127 <bf>reject/announce [0-9] <pattern></bf> Set a reject filter
\r
3132 Create an 'reject this announce' line for a filter.
\r
3134 An reject filter line means that if the announce matches this filter it is
\r
3135 passed onto the user. See HELP FILTERS for more info. Please read this
\r
3136 to understand how filters work - it will save a lot of grief later on.
\r
3138 You can use any of the following things in this line:-
\r
3141 info <string> eg: iota or qsl
\r
3142 by <prefixes> eg: G,M,2
\r
3144 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
\r
3145 origin_itu <numbers>
\r
3146 origin_zone <numbers>
\r
3150 channel <prefixes>
\r
3151 wx 1 filter WX announces
\r
3152 dest <prefixes> eg: 6MUK,WDX (distros)
\r
3158 rej/ann by_zone 14,15,16 and not by G,M,2
\r
3161 You can use the tag 'all' to reject everything eg:
\r
3167 but this probably for advanced users...
\r
3169 <sect1>reject/announce (extended for sysops) (8)
\r
3173 <bf>reject/announce <call> [input] [0-9] <pattern></bf> Announce filter sysop version
\r
3177 This version allows a sysop to set a filter for a callsign as well as the
\r
3178 default for nodes and users eg:-
\r
3181 reject/ann by G,M,2
\r
3182 reject/ann input node_default by G,M,2
\r
3183 reject/ann user_default by G,M,2
\r
3186 <sect1>reject/route (8)
\r
3190 <bf>reject/route <call> [0-9] <pattern></bf> Set an 'reject' filter line for routing
\r
3194 Create an 'reject this routing PC Protocol' line for a filter.
\r
3197 An reject filter line means that if a PC16/17/19/21/24/41/50 matches this filter
\r
3198 it is NOT passed thru that interface. See HELP FILTERING for more info. Please
\r
3199 read this to understand how filters work - it will save a lot of grief later on.
\r
3200 You can use any of the following things in this line:-
\r
3203 call <prefixes> the callsign of the thingy
\r
3204 call_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
\r
3205 call_itu <numbers>
\r
3206 call_zone <numbers>
\r
3207 origin <prefixes> really the interface it came in on
\r
3208 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
\r
3209 origin_itu <numbers>
\r
3210 origin_zone <numbers>
\r
3217 rej/route gb7djk call_dxcc 61,38 (everything except UK+EIRE nodes)
\r
3221 You can use the tag 'all' to reject everything eg:
\r
3224 rej/route all (equiv to [very] restricted mode)
\r
3227 <sect1>reject/spots (0)
\r
3231 <bf>reject/spots [0-9] <pattern></bf> Set a reject filter
\r
3236 Create a 'reject this spot' line for a filter.
\r
3238 A reject filter line means that if the spot matches this filter it is
\r
3239 dumped (not passed on). See HELP FILTERS for more info. Please read this
\r
3240 to understand how filters work - it will save a lot of grief later on.
\r
3242 You can use any of the following things in this line:-
\r
3245 freq <range> eg: 0/30000 or hf or hf/cw or 6m,4m,2m
\r
3246 on <range> same as 'freq'
\r
3247 call <prefixes> eg: G,PA,HB9
\r
3248 info <string> eg: iota or qsl
\r
3250 call_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
\r
3251 call_itu <numbers>
\r
3252 call_zone <numbers>
\r
3257 channel <prefixes>
\r
3260 For frequencies, you can use any of the band names defined in
\r
3261 SHOW/BANDS and you can use a subband name like: cw, rtty, data, ssb -
\r
3262 thus: hf/ssb. You can also just have a simple range like: 0/30000 -
\r
3263 this is more efficient than saying simply: on HF (but don't get
\r
3264 too hung up about that)
\r
3270 rej/spot 2 on vhf and not (by_zone 14,15,16 or call_zone 14,15,16)
\r
3273 You can use the tag 'all' to reject everything eg:
\r
3279 but this probably for advanced users...
\r
3281 <sect1>reject/spots (extended for sysops) (8)
\r
3285 <bf>reject/spots <call> [input] [0-9] <pattern></bf>
\r
3286 Reject spot filter sysop version
\r
3290 This version allows a sysop to set a filter for a callsign as well as the
\r
3291 default for nodes and users eg:-
\r
3294 reject/spot db0sue-7 1 by_zone 14,15,16
\r
3295 reject/spot node_default all
\r
3296 set/hops node_default 10
\r
3298 reject/spot user_default by G,M,2
\r
3301 <sect1>reject/wcy (0)
\r
3305 <bf>reject/wcy [0-9] <pattern></bf> Set a reject WCY filter
\r
3309 It is unlikely that you will want to do this, but if you do then you can
\r
3310 filter on the following fields:-
\r
3313 by <prefixes> eg: G,M,2
\r
3315 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
\r
3316 origin_itu <numbers>
\r
3317 origin_zone <numbers>
\r
3321 channel <prefixes>
\r
3324 There are no examples because WCY Broadcasts only come from one place and
\r
3325 you either want them or not (see UNSET/WCY if you don't want them).
\r
3327 This command is really provided for future use.
\r
3329 See HELP FILTER for information.
\r
3331 <sect1>reject/wcy (extended for sysops) (8)
\r
3335 <bf>reject/wcy <call> [input] [0-9] <pattern></bf>
\r
3336 WCY reject filter sysop version
\r
3340 This version allows a sysop to set a filter for a callsign as well as the
\r
3341 default for nodes and users eg:-
\r
3343 reject/wcy gb7djk all
\r
3345 <sect1>reject/wwv (0)
\r
3349 <bf>reject/wwv [0-9] <pattern></bf> Set a reject WWV filter
\r
3353 It is unlikely that you will want to do this, but if you do then you can
\r
3354 filter on the following fields:-
\r
3357 by <prefixes> eg: G,M,2
\r
3359 origin_dxcc <numbers> eg: 61,62 (from eg: sh/pre G)
\r
3360 origin_itu <numbers>
\r
3361 origin_zone <numbers>
\r
3365 channel <prefixes>
\r
3371 reject/wwv by_zone 14,15,16
\r
3374 is probably the only useful thing to do (which will only show WWV broadcasts
\r
3375 by stations in the US).
\r
3377 See HELP FILTER for information.
\r
3379 <sect1>reject/wwv (extended for sysops) (8)
\r
3383 <bf>reject/wwv <call> [input] [0-9] <pattern></bf>
\r
3384 WWV reject filter sysop version
\r
3387 <P>This version allows a sysop to set a filter for a callsign as well as the
\r
3388 default for nodes and users eg:-
\r
3391 reject/wwv db0sue-7 1 by_zone 4
\r
3392 reject/wwv node_default all
\r
3394 reject/wwv user_default by W
\r
3401 <bf>reply</bf> Reply (privately) to the last message that you have read<newline>
\r
3402 <bf>reply <msgno></bf> Reply (privately) to the specified message<newline>
\r
3403 <bf>reply B <msgno></bf> Reply as a Bulletin to the specified message<newline>
\r
3404 <bf>reply NOPrivate <msgno></bf> Reply as a Bulletin to the specified
\r
3406 <bf>reply RR <msgno></bf> Reply to the specified message with read
\r
3411 You can reply to a message and the subject will automatically have
\r
3412 "Re:" inserted in front of it, if it isn't already present.
\r
3414 You can also use all the extra qualifiers such as RR, PRIVATE,
\r
3415 NOPRIVATE, B that you can use with the SEND command (see SEND
\r
3416 for further details)
\r
3422 <bf>send <call> [<call> ...]</bf> Send a message to
\r
3423 one or more callsigns<newline>
\r
3424 <bf>send RR <call></bf> Send a message and ask for a read receipt<newline>
\r
3425 <bf>send COPY <msgno> <call></bf> Send a copy of a message
\r
3426 to someone<newline>
\r
3427 <bf>send PRIVATE <call></bf> Send a personal message<newline>
\r
3428 <bf>send NOPRIVATE <call></bf> Send a message to all stations<newline>
\r
3432 All the SEND commands will create a message which will be sent either to
\r
3433 an individual callsign or to one of the 'bulletin' addresses.
\r
3435 SEND <call> on its own acts as though you had typed SEND PRIVATE, that is
\r
3436 it will mark the message as personal and send it to the cluster node that
\r
3437 that callsign is connected to.
\r
3439 You can have more than one callsign in all of the SEND commands.
\r
3441 You can have multiple qualifiers so that you can have for example:-
\r
3444 SEND RR COPY 123 PRIVATE G1TLH G0RDI
\r
3447 which should send a copy of message 123 to G1TLH and G0RDI and you will
\r
3448 receive a read receipt when they have read the message.
\r
3450 SB is an alias for SEND NOPRIVATE (or send a bulletin in BBS speak)
\r
3451 SP is an alias for SEND PRIVATE
\r
3453 <sect1>set/address (0)
\r
3457 <bf>set/address <your_address></bf> Record your postal address
\r
3461 Literally, record your address details on the cluster.
\r
3463 <sect1>set/announce (0)
\r
3467 <bf>set/announce</bf> Allow announce messages
\r
3471 Allow announce messages to arrive at your terminal.
\r
3473 <sect1>set/arcluster (5)
\r
3477 <bf>set/arcluster <node_call> [<node_call> ...]</bf> Make
\r
3478 the node_call an AR-Cluster type node
\r
3482 Set the node_call as an AR-Cluster type node
\r
3484 <sect1>set/baddx (8)
\r
3488 <bf>set/baddx <call></bf> Stop words we do not wish to see in the callsign field
\r
3489 of a dx spot being propagated
\r
3493 Setting a word as 'baddx' will prevent spots with that word in the callsign
\r
3494 field of a DX spot from going any further. They will not be displayed and they
\r
3495 will not be sent onto other nodes.
\r
3497 The word must be wriiten in full, no wild cards are allowed eg:-
\r
3500 set/baddx FORSALE VIDEO FR0G
\r
3503 To allow a word again, use the following command ...
\r
3509 <sect1>set/badnode (6)
\r
3513 <bf>set/badnode <node_call></bf> Stop spots from this node_call
\r
3518 Setting a callsign as a 'badnode' will prevent spots from that node
\r
3519 going any further. They will not be displayed and they will not be
\r
3520 sent onto other nodes.
\r
3522 The call can be a full or partial call (or a prefix), eg:-
\r
3525 set/badnode K1TTT
\r
3528 will stop anything from K1TTT (including any SSID's)
\r
3531 unset/badnode K1TTT
\r
3534 will allow spots from him again.
\r
3536 Use with extreme care. This command may well be superceded by FILTERing.
\r
3538 <sect1>set/badspotter (8)
\r
3542 <bf>set/badspotter <call></bf> Stop spots from this callsign being propagated
\r
3546 Setting a callsign as a 'badspotter' will prevent spots from this callsign
\r
3547 going any further. They will not be displayed and they will not be
\r
3548 sent onto other nodes.
\r
3550 The call must be written in full, no wild cards are allowed eg:-
\r
3553 set/badspotter VE2STN
\r
3556 will stop anything from VE2STN. If you want SSIDs as well then you must
\r
3557 enter them specifically.
\r
3560 unset/badspotter VE2STN
\r
3563 will allow spots from him again.
\r
3565 Use with extreme care. This command may well be superceded by FILTERing.
\r
3567 <sect1>set/badword (8)
\r
3571 <bf>set/badword <word></bf> Stop things with this word being propogated
\r
3575 Setting a word as a 'badword' will prevent things like spots,
\r
3576 announces or talks with this word in the the text part from going any
\r
3577 further. They will not be displayed and they will not be sent onto
\r
3580 The word must be written in full, no wild cards are allowed eg:-
\r
3582 set/badword annihilate annihilated annihilation
\r
3584 will stop anything with these words in the text.
\r
3586 unset/badword annihilated
\r
3588 will allow text with this word again.
\r
3591 <sect1>set/beep (0)
\r
3595 <bf>set/beep</bf> Add beeps to terminal messages
\r
3599 Add a beep to DX and other terminal messages.
\r
3601 <sect1>set/bbs (5)
\r
3605 <bf>set/bbs <call> [<call>..]</bf>Make <call> a BBS
\r
3608 <sect1>set/clx (5)
\r
3612 <bf>set/clx <node_call> [<node_call> ...]</bf> Make
\r
3613 the node_call a CLX type node
\r
3617 Set the node_call as a CLX type node
\r
3619 <sect1>set/debug (9)
\r
3623 <bf>set/debug <name></bf> Add a debug level to the debug set
\r
3627 You can choose to log several different levels. The levels are
\r
3635 You can show what levels you are logging with the <em>show/debug</em>
\r
3638 You can remove a debug level with unset/debug <name>
\r
3644 <bf>set/dx</bf>Allow DX messages to arrive at your terminal
\r
3648 You can stop DX messages with the <em>unset/dx</em> command
\r
3650 <sect1>set/dxgrid (0)
\r
3654 <bf>set/dxgrid</bf>Allow grid squares on the end of DX messages
\r
3658 Some logging programs do not like the additional information at
\r
3659 the end of a DX spot. If this is the case, use the <em>unset/dxgrid</em>
\r
3660 command to remove the grid squares.
\r
3662 <sect1>set/dxnet (5)
\r
3666 <bf>set/dxnet <node_call> [<node_call> ...]</bf> Make
\r
3667 the node_call a DXNet type node
\r
3671 Set the node_call as a DXNet type node
\r
3673 <sect1>set/echo (0)
\r
3677 <bf>set/echo</bf> Make the cluster echo your input
\r
3681 If you are connected via a telnet session, different implimentations
\r
3682 of telnet handle echo differently depending on whether you are
\r
3683 connected via port 23 or some other port. You can use this command
\r
3684 to change the setting appropriately.
\r
3686 You can remove the echo with the <em>unset/echo</em> command
\r
3688 The setting is stored in your user profile.
\r
3690 YOU DO NOT NEED TO USE THIS COMMAND IF YOU ARE CONNECTED VIA AX25.
\r
3692 <sect1>set/email (0)
\r
3696 <bf>set/email <email_address></bf> Set email address(es) and forward your personals
\r
3700 If any personal messages come in for your callsign then you can use
\r
3701 these commands to control whether they are forwarded onto your email
\r
3702 address. To enable the forwarding do something like:-
\r
3704 SET/EMAIL mike.tubby@somewhere.com
\r
3706 You can have more than one email address (each one separated by a space).
\r
3707 Emails are forwarded to all the email addresses you specify.
\r
3709 You can disable forwarding by:-
\r
3713 <sect1>set/here (0)
\r
3717 <bf>set/here</bf> Set the here flag
\r
3721 Let others on the cluster know you are here by only displaying your
\r
3722 callsign. If you are away from your terminal you can use the <em>unset/here</em>
\r
3723 command to let people know you are away. This simply puts brackets
\r
3724 around your callsign to indicate you are not available.
\r
3726 <sect1>set/homenode (0)
\r
3730 <bf>set/homenode <node_call></bf> Set your home cluster
\r
3734 Tell the cluster system where you normally connect to. Any Messages sent
\r
3735 to you will normally find their way there should you not be connected.
\r
3739 SET/HOMENODE gb7djk
\r
3742 <sect1>set/hops (8)
\r
3746 <bf>set/hops <node_call> ann|spots|wwv|wcy <n></bf>
\r
3751 Set the hop count for a particular type of broadcast for a node.
\r
3753 This command allows you to set up special hop counts for a node
\r
3754 for currently: announce, spots, wwv and wcy broadcasts.
\r
3758 set/hops gb7djk ann 10
\r
3759 set/hops gb7mbc spots 20
\r
3762 Set SHOW/HOPS for information on what is already set. This command
\r
3763 creates a filter and works in conjunction with the filter system.
\r
3765 <sect1>set/isolate (9)
\r
3769 <bf>set/isolate <node call></bf> Isolate a node from the rest of the network
\r
3773 Connect a node to your system in such a way that you are a full protocol
\r
3774 member of its network and can see all spots on it, but nothing either leaks
\r
3775 out from it nor goes back into from the rest of the nodes connected to you.
\r
3777 You can potentially connect several nodes in this way.
\r
3779 You can see which nodes are isolated with the show/isolate (1) command.
\r
3781 You can remove the isolation with the command unset/isolate.
\r
3783 <sect1>set/language (0)
\r
3787 <bf>set/language <language></bf> Set the language you wish to use
\r
3791 You can select the language that you want the cluster to use. Currently
\r
3792 the languages available are <em>en</em> (English) and <em>nl</em> (Dutch).
\r
3794 <sect1>set/location (0)
\r
3798 <bf>set/location <lat and long></bf> Set your latitude and longitude
\r
3802 You can set your latitude and longitude manually or alternatively use the
\r
3803 <em>set/qra</em> command which will do the conversion for you.
\r
3806 set/location 54 04 N 2 02 E
\r
3810 <sect1>set/sys_location (9)
\r
3814 <bf>set/sys_location <lat & long></bf> Set your cluster latitude and longitude
\r
3818 In order to get accurate headings and such like you must tell the system
\r
3819 what your latitude and longitude is. If you have not yet done a SET/QRA
\r
3820 then this command will set your QRA locator for you. For example:-
\r
3823 SET/LOCATION 52 22 N 0 57 E
\r
3826 <sect1>set/logininfo (0)
\r
3830 <bf>set/logininfo</bf> Show logins and logouts of nodes and users
\r
3834 Show users and nodes when they log in and out of the local cluster. You
\r
3835 can stop these messages by using the <em>unset/logininfo</em> command.
\r
3838 <sect1>set/lockout (9)
\r
3842 <bf>set/lockout <call></bf> Stop a callsign connecting to the cluster
\r
3846 You can show who is locked out with the <em>show/lockout</em> command.
\r
3847 To allow the user to connect again, use the <em>unset/lockout</em> command.
\r
3849 <sect1>set/name (0)
\r
3853 <bf>set/name <your_name></bf> Set your name
\r
3857 Tell the cluster what your name is, eg:-
\r
3863 <sect1>set/node (9)
\r
3867 <bf>set/node <call> [<call> ...]</bf> Make the callsign an AK1A cluster
\r
3871 Tell the system that the call(s) are to be treated as AK1A cluster and
\r
3872 fed PC Protocol rather normal user commands.
\r
3874 From version 1.41 you can also set the following types of cluster
\r
3883 To see what your nodes are set to, use the <em>show/nodes</em> command.
\r
3885 <sect1>set/obscount (9)
\r
3889 <bf>set/obscount <count> <node call></bf> Set the 'pump-up'
\r
3890 obsolescence counter
\r
3894 From version 1.35 onwards neighbouring nodes are pinged at regular intervals (see
\r
3895 SET/PINGINTERVAL), usually 300 seconds or 5 minutes. There is a 'pump-up'
\r
3896 counter which is decremented on every outgoing ping and then reset to
\r
3897 the 'obscount' value on every incoming ping. The default value of this
\r
3900 What this means is that a neighbouring node will be pinged twice at
\r
3901 (default) 300 second intervals and if no reply has been heard just before
\r
3902 what would be the third attempt, that node is disconnected.
\r
3904 If a ping is heard then the obscount is reset to the full value. Using
\r
3905 default values, if a node has not responded to a ping within 15 minutes,
\r
3906 it is disconnected.
\r
3908 <sect1>set/page (0)
\r
3912 <bf>set/page <n></bf> Set the number of lines per page
\r
3916 Tell the system how many lines you wish on a page when the number of lines
\r
3917 of output from a command is more than this. The default is 20. Setting it
\r
3918 explicitly to 0 will disable paging.
\r
3925 The setting is stored in your user profile.
\r
3927 <sect1>set/password (0)
\r
3931 <bf>set/password</bf> Set your own password
\r
3935 This command only works for a 'telnet' user (currently). It will
\r
3936 only work if you have a password already set. This initial password
\r
3937 can only be set by the sysop.
\r
3939 When you execute this command it will ask you for your old password,
\r
3940 then ask you to type in your new password twice (to make sure you
\r
3941 get it right). You may or may not see the data echoed on the screen
\r
3942 as you type, depending on the type of telnet client you have.
\r
3944 <sect1>set/password (9)
\r
3948 <bf>set/password <callsign> <string></bf> Set a users password
\r
3952 The password for a user can only be set by a full sysop. The string
\r
3953 can contain any characters.
\r
3955 The way this field is used depends on context. If it is being used in
\r
3956 the SYSOP command context then you are offered 5 random numbers and you
\r
3957 have to supply the corresponding letters. This is now mainly for ax25
\r
3960 If it is being used on incoming telnet connections then, if a password
\r
3963 set/var $main::passwdreq = 1
\r
3965 command is executed in the startup script, then a password prompt is
\r
3966 given after the normal 'login: ' prompt.
\r
3968 The command "unset/password" is provided to allow a sysop to remove a
\r
3969 users password completely in case a user forgets or loses their password.
\r
3971 <sect1>set/pinginterval (9)
\r
3974 <tt><bf>set/pinginterval <time> <node call></bf> Set the ping time
\r
3975 to neighbouring nodes
\r
3979 As from version 1.35 all neighbouring nodes are pinged at regular intervals
\r
3980 in order to determine the rolling quality of the link and, in future, to
\r
3981 affect routing decisions. The default interval is 300 secs or 5 minutes.
\r
3983 You can use this command to set a different interval. Please don't.
\r
3985 But if you do the value you enter is treated as minutes up 60 and seconds
\r
3986 for numbers greater than that.
\r
3988 This is used also to help determine when a link is down at the far end
\r
3989 (as certain cluster software doesn't always notice), see SET/OBSCOUNT
\r
3990 for more information.
\r
3992 <sect1>set/privilege (9)
\r
3996 <bf>set/privilege <n> <call> [<call> ...]</bf> Set the
\r
3997 privilege level on a call
\r
4001 Set the privilege level on a callsign. The privilege levels that pertain
\r
4002 to commands are as default:-
\r
4006 1 - allow remote nodes normal user RCMDs
\r
4007 5 - various privileged commands (including shutdown, but not disc-
\r
4008 connect), the normal level for another node.
\r
4009 8 - more privileged commands (including disconnect)
\r
4010 9 - local sysop privilege. DO NOT SET ANY REMOTE USER OR NODE TO THIS
\r
4014 If you are a sysop and you come in as a normal user on a remote connection
\r
4015 your privilege will automatically be set to 0.
\r
4017 <sect1>set/spider (5)
\r
4021 <bf>set/spider <node_call> [<node_call> ...]</bf> Make
\r
4022 the node_call a DXSpider type node
\r
4026 Set the node_call as a DXSpider type node
\r
4028 <sect1>set/sys_qra (9)
\r
4032 <bf>set/sys_qra <locator></bf> Set your cluster QRA locator
\r
4035 <sect1>set/qra (0)
\r
4039 <bf>set/qra <locator></bf> Set your QRA locator
\r
4043 Tell the system what your QRA (or Maidenhead) locator is. If you have not
\r
4044 done a SET/LOCATION then your latitude and longitude will be set roughly
\r
4045 correctly (assuming your locator is correct ;-). For example:-
\r
4051 <sect1>set/qth (0)
\r
4055 <bf>set/qth <your QTH></bf> Set your QTH
\r
4059 Tell the system where your are. For example:-
\r
4062 set/qth East Dereham, Norfolk
\r
4065 <sect1>set/register (9)
\r
4069 <bf>set/register <call></bf> Mark a user as registered
\r
4073 Registration is a concept that you can switch on by executing the
\r
4075 set/var $main::regreq = 1
\r
4077 command (usually in your startup file)
\r
4079 If a user is NOT registered then, firstly, instead of the normal
\r
4080 motd file (/spider/data/motd) being sent to the user at startup, the
\r
4081 user is sent the motd_nor file instead. Secondly, the non registered
\r
4082 user only has READ-ONLY access to the node. The non-registered user
\r
4083 cannot use DX, ANN etc.
\r
4085 The only exception to this is that a non-registered user can TALK or
\r
4086 SEND messages to the sysop.
\r
4088 To unset a user use the 'unset/register' command
\r
4090 <sect1>set/talk (0)
\r
4094 <bf>set/talk</bf> Allow talk messages to be seen at your console
\r
4098 Allow talk messages to arrive at your console. You can switch off
\r
4099 talks with the <em>unset/talk</em> command.
\r
4101 <sect1>set/wcy (0)
\r
4105 <bf>set/wcy</bf> Allow WCY messages to be seen at your console
\r
4109 Allow WCY information to be seen at your console. You can switch off
\r
4110 WCY messages with the <em>unset/wcy</em> command.
\r
4112 <sect1>set/wwv (0)
\r
4116 <bf>set/wwv</bf> Allow WWV messages to be seen at your console
\r
4120 Allow WWV information to be seen at your console. You can switch off
\r
4121 WWV messages with the <em>unset/wwv</em> command.
\r
4127 <bf>set/wx</bf> Allow WX messages to be seen at your console
\r
4131 Allow WX information to be seen at your console. You can switch off
\r
4132 WX messages with the <em>unset/wx</em> command.
\r
4134 <sect1>show/baddx (1)
\r
4138 <bf>show/baddx</bf>Show all the bad dx calls in the system
\r
4142 Display all the bad dx callsigns in the system, see SET/BADDX
\r
4143 for more information.
\r
4145 <sect1>show/badnode (6)
\r
4149 <bf>show/badnode</bf> Show all the bad nodes in the system
\r
4153 Display all the bad node callsigns in the system, see SET/BADNODE
\r
4154 for more information.
\r
4156 <sect1>show/badspotter (1)
\r
4160 <bf>show/badspotter</bf> Show all the bad spotters in the system
\r
4164 Display all the bad spotter's callsigns in the system, see SET/BADSPOTTER
\r
4165 for more information.
\r
4167 <sect1>show/badword (1)
\r
4171 <bf>show/badword</bf> Show all the bad words in the system
\r
4175 Display all the bad words in the system, see SET/BADWORD
\r
4176 for more information.
\r
4178 <sect1>show/configuration (0)
\r
4182 <bf>show/configuration [<node>]</bf> Show all visible nodes and their users
\r
4186 This command allows you to see all the users that can be seen
\r
4187 and the nodes to which they are connected. With the optional <em>node</em>,
\r
4188 you can specify a particular node to look at.
\r
4190 This command is normally abbreviated to: sh/c
\r
4192 BE WARNED: the list that is returned can be VERY long
\r
4194 <sect1>show/configuration/node (0)
\r
4198 <bf>show/configuration/node</bf> Show all the nodes connected
\r
4202 Show all the nodes connected locally and the nodes they have connected.
\r
4204 <sect1>show/connect (1)
\r
4208 <bf>show/connect</bf> Show all the active connections
\r
4212 This command shows information on all the active connections known to
\r
4213 the node. This command gives slightly more information than WHO.
\r
4215 <sect1>show/date (0)
\r
4219 <bf>show/date [<prefix>|<callsign>]</bf> Show
\r
4224 This is very nearly the same as SHOW/TIME, the only difference the format
\r
4225 of the date string if no arguments are given.
\r
4227 If no prefixes or callsigns are given then this command returns the local
\r
4228 time and UTC as the computer has it right now. If you give some prefixes
\r
4229 then it will show UTC and UTC + the local offset (not including DST) at
\r
4230 the prefixes or callsigns that you specify.
\r
4232 <sect1>show/debug (9)
\r
4236 <bf>show/debug</bf> Show what levels of debug you are logging
\r
4240 The levels can be set with <em>set/debug</em>
\r
4242 <sect1>show/dx (0)
\r
4246 <bf>show/dx [options]</bf> interrogate the spot database
\r
4250 If you just type SHOW/DX you will get the last so many spots
\r
4251 (sysop configurable, but usually 10).
\r
4253 In addition you can add any number of these options in very nearly
\r
4254 any order to the basic SHOW/DX command, they are:-
\r
4257 on <band> - eg 160m 20m 2m 23cm 6mm
\r
4258 on <region> - eg hf vhf uhf shf (see SHOW/BANDS)
\r
4260 <number> - the number of spots you want
\r
4261 <from>-<to> - <from> spot no <to> spot no in
\r
4264 <prefix> - for a spotted callsign beginning with <prefix>
\r
4265 *<suffix> - for a spotted callsign ending in <suffix>
\r
4266 *<string>* - for a spotted callsign containing <string>
\r
4268 day <number> - starting <number> days ago
\r
4269 day <from>-<to> - <from> days <to> days ago
\r
4271 info <text> - any spots containing <text> in the info or remarks
\r
4273 by <call> - any spots spotted by <call> (spotter <call>
\r
4276 qsl - this automatically looks for any qsl info on the call
\r
4277 held in the spot database.
\r
4279 iota [<iota>] - If the iota island number is missing it will
\r
4280 look for the string iota and anything which looks like
\r
4281 an iota island number. If you specify then it will look
\r
4284 qra [<locator>] - this will look for the specific locator if
\r
4285 you specify one or else anything that looks like a locator.
\r
4292 SH/DX on 20m info iota
\r
4293 SH/DX 9a on vhf day 30
\r
4300 <sect1>show/dxcc (0)
\r
4304 <bf>show/dxcc <prefix></bf> Interrogate the spot database by country
\r
4308 This command takes the <prefix> (which can be a full or partial
\r
4309 callsign if desired), looks up which internal country number it is
\r
4310 and then displays all the spots as per SH/DX for that country.
\r
4312 The options for SHOW/DX also apply to this command.
\r
4317 SH/DXCC W on 20m info iota
\r
4320 <sect1>sh/dxstats (0)
\r
4324 <bf>sh/dxstats</bf> Show the DX Statistics for last 31 days
\r
4328 Show the total DX spots for the last 31 days
\r
4331 <sect1>show/files (0)
\r
4335 <bf>show/files [<filearea> [<string>]]</bf> List
\r
4336 the contents of a filearea
\r
4340 SHOW/FILES on its own will show you a list of the various fileareas
\r
4341 available on the system. To see the contents of a particular file
\r
4345 SH/FILES <filearea>
\r
4348 where <filearea> is the name of the filearea you want to see the
\r
4351 You can also use shell globbing characters like '*' and '?' in a
\r
4352 string to see a selection of files in a filearea eg:-
\r
4355 SH/FILES bulletins arld*
\r
4358 See also TYPE - to see the contents of a file.
\r
4360 <sect1>show/filter (0)
\r
4364 <bf>show/filter</bf> Show the filters you have set
\r
4368 Show the contents of all the filters that are set by you. This command
\r
4369 displays all the filters set - for all the various categories.
\r
4371 <sect1>show/filter (extended for sysops) (5)
\r
4375 <bf>show/filter <callsign></bf> Show the filters set by <callsign>
\r
4379 A sysop can look at any filters that have been set.
\r
4381 <sect1>show/hfstats (0)
\r
4385 <bf>show/hfstats</bf> Show the HF DX Statistics for last 31 days
\r
4389 Show the HF DX spots breakdown by band for the last 31 days
\r
4391 <sect1>show/hftable (0)
\r
4395 <bf>show/hftable</bf> Show the HF DX Spotter Table for your country
\r
4399 Show the HF DX Spotter table for your country for the last 31 days
\r
4401 <sect1>show/hops (8)
\r
4405 <bf>show/hops <node_call> [ann|spots|wcy|wwv|]</bf> Show the hop
\r
4410 This command shows the hop counts set up for a node. You can specify
\r
4411 which category you want to see. If you leave the category out then
\r
4412 all the categories will be listed.
\r
4414 <sect1>show/isolate (1)
\r
4418 <bf>show/isolate</bf> Show a list of isolated nodes
\r
4422 Show which nodes are currently set to be isolated.
\r
4424 <sect1>show/lockout (9)
\r
4428 <bf>show/lockout</bf> Show a list of excluded callsigns
\r
4432 Show a list of callsigns that have been excluded (locked out) of the
\r
4433 cluster locally with the <em>set/lockout</em> command
\r
4435 <sect1>show/log (8)
\r
4439 <bf>show/log [<callsign>]</bf> Show excerpts from the system log
\r
4443 This command outputs a short section of the system log. On its own
\r
4444 it will output a general logfile. With the optional callsign it will
\r
4445 show output from the log associated with that callsign.
\r
4447 <sect1>show/moon (0)
\r
4451 <bf>show/moon [<prefix>|<callsign>]</bf> Show moon
\r
4452 rise and set times
\r
4456 Show the Moon rise and set times for a (list of) prefixes or callsigns,
\r
4457 together with the azimuth and elevation of the sun currently at those
\r
4460 If you don't specify any prefixes or callsigns, it will show the times for
\r
4461 your QTH (assuming you have set it with either SET/LOCATION or SET/QRA),
\r
4462 together with the current azimuth and elevation.
\r
4464 In addition, it will show the gain or loss dB relative to the nominal
\r
4465 distance of 385,000Km due to the ellipsoidal nature of the orbit.
\r
4467 If all else fails it will show the Moonrise and set times for the node
\r
4468 that you are connected to.
\r
4474 SH/MOON G1TLH W5UN
\r
4477 <sect1>show/muf (0)
\r
4481 <bf>show/muf <prefix> [<hours>][long]</bf> Show
\r
4482 the likely propagation to <prefix>
\r
4486 This command allow you to estimate the likelihood of you contacting
\r
4487 a station with the prefix you have specified. The output assumes a modest
\r
4488 power of 20dBW and receiver sensitivity of -123dBm (about 0.15muV/10dB SINAD)
\r
4490 The result predicts the most likely operating frequencies and signal
\r
4491 levels for high frequency (shortwave) radio propagation paths on
\r
4492 specified days of the year and hours of the day. It is most useful for
\r
4493 paths between 250 km and 6000 km, but can be used with reduced accuracy
\r
4494 for paths shorter or longer than this.
\r
4496 The command uses a routine MINIMUF 3.5 developed by the U.S. Navy and
\r
4497 used to predict the MUF given the predicted flux, day of the year,
\r
4498 hour of the day and geographic coordinates of the transmitter and
\r
4499 receiver. This routine is reasonably accurate for the purposes here,
\r
4500 with a claimed RMS error of 3.8 MHz, but much smaller and less complex
\r
4501 than the programs used by major shortwave broadcasting organizations,
\r
4502 such as the Voice of America.
\r
4504 The command will display some header information detailing its
\r
4505 assumptions, together with the locations, latitude and longitudes and
\r
4506 bearings. It will then show UTC (UT), local time at the other end
\r
4507 (LT), calculate the MUFs, Sun zenith angle at the midpoint of the path
\r
4508 (Zen) and the likely signal strengths. Then for each frequency for which
\r
4509 the system thinks there is a likelihood of a circuit it prints a value.
\r
4511 The value is currently a likely S meter reading based on the conventional
\r
4512 6dB / S point scale. If the value has a '+' appended it means that it is
\r
4513 1/2 an S point stronger. If the value is preceeded by an 'm' it means that
\r
4514 there is likely to be much fading and by an 's' that the signal is likely
\r
4517 By default SHOW/MUF will show the next two hours worth of data. You
\r
4518 can specify anything up to 24 hours worth of data by appending the no of
\r
4519 hours required after the prefix. For example:-
\r
4528 RxSens: -123 dBM SFI: 159 R: 193 Month: 10 Day: 21
\r
4529 Power : 20 dBW Distance: 6283 km Delay: 22.4 ms
\r
4530 Location Lat / Long Azim
\r
4531 East Dereham, Norfolk 52 41 N 0 57 E 47
\r
4532 United-States-W 43 0 N 87 54 W 299
\r
4533 UT LT MUF Zen 1.8 3.5 7.0 10.1 14.0 18.1 21.0 24.9 28.0 50.0
\r
4534 18 23 11.5 -35 mS0+ mS2 S3
\r
4535 19 0 11.2 -41 mS0+ mS2 S3
\r
4538 indicating that you will have weak, fading circuits on top band and
\r
4539 80m but usable signals on 40m (about S3).
\r
4547 will get you the above display, but with the next 24 hours worth of
\r
4555 Gives you an estimate of the long path propagation characterics. It
\r
4556 should be noted that the figures will probably not be very useful, nor
\r
4557 terrible accurate, but it is included for completeness.
\r
4559 <sect1>show/newconfiguration (0)
\r
4563 <bf>show/newconfiguration [<node>]</bf> Show all the nodes and users visible
\r
4567 This command allows you to see all the users that can be seen
\r
4568 and the nodes to which they are connected.
\r
4570 This command produces essentially the same information as
\r
4571 SHOW/CONFIGURATION except that it shows all the duplication of
\r
4572 any routes that might be present It also uses a different format
\r
4573 which may not take up quite as much space if you don't have any
\r
4576 BE WARNED: the list that is returned can be VERY long
\r
4578 <sect1>show/newconfiguration/node (0)
\r
4582 <bf>show/newconfiguration/node</bf> Show all the nodes connected locally
\r
4586 Show all the nodes connected to this node in the new format.
\r
4588 <sect1>show/node (1)
\r
4592 <bf>show/node [<node_call> ...]</bf> Show the type and version
\r
4597 Show the type and version (if connected) of the nodes specified on the
\r
4598 command line. If no callsigns are specified then a sorted list of all
\r
4599 the non-user callsigns known to the system will be displayed.
\r
4601 <sect1>show/prefix (0)
\r
4605 <bf>show/prefix <callsign></bf> Interrogate the prefix database
\r
4609 This command takes the <callsign> (which can be a full or partial
\r
4610 callsign or a prefix), looks up which internal country number
\r
4611 it is and then displays all the relevant prefixes for that country
\r
4612 together with the internal country no, the CQ and ITU regions.
\r
4614 See also SHOW/DXCC
\r
4617 <sect1>show/program (5)
\r
4621 <bf>show/program</bf> Show the locations of all the included program modules
\r
4625 Show the name and location where every program module was load from. This
\r
4626 is useful for checking where you think you have loaded a .pm file from.
\r
4628 <sect1>show/qra (0)
\r
4632 <bf>show/qra <locator> [<locator>]</bf> Show the distance
\r
4633 between locators<newline>
\r
4634 <bf>show/qra <lat> <long></bf> Convert latitude and longitude to
\r
4639 This is a multipurpose command that allows you either to calculate the
\r
4640 distance and bearing between two locators or (if only one locator is
\r
4641 given on the command line) the distance and beraing from your station
\r
4642 to the locator. For example:-
\r
4649 The first example will show the distance and bearing to the locator from
\r
4650 yourself, the second example will calculate the distance and bearing from
\r
4651 the first locator to the second. You can use 4 or 6 character locators.
\r
4653 It is also possible to convert a latitude and longitude to a locator by
\r
4654 using this command with a latitude and longitude as an argument, for
\r
4658 SH/QRA 52 41 N 0 58 E
\r
4661 <sect1>show/qrz (0)
\r
4665 <bf>show/qrz <callsign></bf> Show any callbook details on a callsign
\r
4669 This command queries the QRZ callbook server on the internet
\r
4670 and returns any information available for that callsign. This service
\r
4671 is provided for users of this software by http://www.qrz.com
\r
4673 <sect1>show/registered (9)
\r
4677 <bf>show/registered [<prefix>[</bf> Show the registered users
\r
4680 <sect1>show/route (0)
\r
4684 <bf>show/route <callsign></bf> Show the route to <callsign>
\r
4688 This command allows you to see to which node the callsigns specified are
\r
4689 connected. It is a sort of inverse sh/config.
\r
4695 <sect1>show/satellite (0)
\r
4699 <bf>show/satellite <name> [<hours> <interval>]</bf>
\r
4700 Show satellite tracking data
\r
4704 Show the tracking data from your location to the satellite of your choice
\r
4705 from now on for the next few hours.
\r
4707 If you use this command without a satellite name it will display a list
\r
4708 of all the satellites known currently to the system.
\r
4710 If you give a name then you can obtain tracking data of all the passes
\r
4711 that start and finish 5 degrees below the horizon. As default it will
\r
4712 give information for the next three hours for every five minute period.
\r
4714 You can alter the number of hours and the step size, within certain
\r
4717 Each pass in a period is separated with a row of '-----' characters
\r
4723 SH/SAT FENGYUN1 12 2
\r
4726 <sect1>show/sun (0)
\r
4730 <bf>show/sun [<prefix>|<callsign>]</bf> Show
\r
4731 sun rise and set times
\r
4735 Show the sun rise and set times for a (list of) prefixes or callsigns,
\r
4736 together with the azimuth and elevation of the sun currently at those
\r
4739 If you don't specify any prefixes or callsigns, it will show the times for
\r
4740 your QTH (assuming you have set it with either SET/LOCATION or SET/QRA),
\r
4741 together with the current azimuth and elevation.
\r
4743 If all else fails it will show the sunrise and set times for the node
\r
4744 that you are connected to.
\r
4750 SH/SUN G1TLH K9CW ZS
\r
4753 <sect1>show/time (0)
\r
4757 <bf>show/time [<prefix>|<callsign>]</bf> Show
\r
4762 If no prefixes or callsigns are given then this command returns the local
\r
4763 time and UTC as the computer has it right now. If you give some prefixes
\r
4764 then it will show UTC and UTC + the local offset (not including DST) at
\r
4765 the prefixes or callsigns that you specify.
\r
4767 <sect1>show/vhfstats (0)
\r
4771 <bf>show/vhfstats</bf> Show the VHF DX Statistics for last 31 days
\r
4775 Show the VHF DX spots breakdown by band for the last 31 days
\r
4777 <sect1>show/vhftable (0)
\r
4781 <bf>show/vhftable</bf> Show the VHF DX Spotter Table for your country
\r
4785 Show the VHF DX Spotter table for your country for the last 31 days
\r
4787 <sect1>show/wcy (0)
\r
4791 <bf>show/wcy</bf> Show the last 10 WCY broadcasts<newline>
\r
4792 <bf>show/wcy <n></bf> Show the last <n> WCY broadcasts
\r
4796 Display the most recent WCY information that has been received by the system
\r
4798 <sect1>show/wwv (0)
\r
4802 <bf>show/wwv</bf> Show the last 10 WWV broadcasts<newline>
\r
4803 <bf>show/wwv <n></bf> Show the last <n> WWV broadcasts
\r
4807 Display the most recent WWV information that has been received by the system
\r
4810 <sect1>shutdown (5)
\r
4814 <bf>shutdown</bf> Shutdown the cluster
\r
4818 Shutdown the cluster and disconnect all the users. If you have Spider
\r
4819 set to respawn in /etc/inittab it will of course restart.
\r
4825 <bf>spoof <callsign> <command></bf> Run commands as another user
\r
4829 This is a very simple yet powerful command for the sysop. It allows you to
\r
4830 issue commands as if you were a different user. This is very useful for the
\r
4831 kind of things that users seem to always get wrong.. like home_node for
\r
4834 <sect1>stat/db (5)
\r
4838 <bf>stat/db <dbname></bf> Show the status of a database
\r
4842 Show the internal status of a database descriptor.
\r
4844 Depending on your privilege level you will see more or less information.
\r
4845 This command is unlikely to be of much use to anyone other than a sysop.
\r
4847 <sect1>stat/channel (5)
\r
4851 <bf>stat/channel <callsign></bf> Show the status of a channel on the cluster
\r
4855 Show the internal status of the channel object either for the channel that
\r
4856 you are on or else for the callsign that you asked for.
\r
4858 Only the fields that are defined (in perl term) will be displayed.
\r
4860 <sect1>stat/msg (5)
\r
4864 <bf>stat/msg <msgno></bf> Show the status of a message
\r
4868 This command shows the internal status of a message and includes information
\r
4869 such as to whom it has been forwarded, its size, origin etc etc.
\r
4872 If no message number is given then the status of the message system is
\r
4875 <sect1>stat/route_node (5)
\r
4879 <bf>stat/route_node <callsign></bf> Show the data in a Route::Node object
\r
4882 <sect1>stat/route_user (5)
\r
4886 <bf>stat/route_user <callsign></bf> Show the data in a Route::User object
\r
4889 <sect1>stat/user (5)
\r
4893 <bf>stat/user <callsign></bf> Show the full status of a user
\r
4897 Shows the full contents of a user record including all the secret flags
\r
4900 Only the fields that are defined (in perl term) will be displayed.
\r
4906 <bf>sysop</bf> Regain your privileges if you login remotely
\r
4910 The system automatically reduces your privilege level to that of a
\r
4911 normal user if you login in remotely. This command allows you to
\r
4912 regain your normal privilege level. It uses the normal system: five
\r
4913 numbers are returned that are indexes into the character array that is
\r
4914 your assigned password (see SET/PASSWORD). The indexes start from
\r
4917 You are expected to return a string which contains the characters
\r
4918 required in the correct order. You may intersperse those characters
\r
4919 with others to obscure your reply for any watchers. For example (and
\r
4920 these values are for explanation :-):
\r
4923 password = 012345678901234567890123456789
\r
4931 aa2bbbb0ccc5ddd7xxx3n
\r
4936 They will all match. If there is no password you will still be offered
\r
4937 numbers but nothing will happen when you input a string. Any match is
\r
4944 <bf>talk <callsign></bf> Enter talk mode with <callsign><newline>
\r
4945 <bf>talk <callsign> <text></bf> Send a text message to <callsign><newline>
\r
4946 <bf>talk <callsign> > <node_call> [<text>]</bf>
\r
4947 Send a text message to <callsign> via <node_call>
\r
4951 Send a short message to any other station that is visible on the cluster
\r
4952 system. You can send it to anyone you can see with a SHOW/CONFIGURATION
\r
4953 command, they don't have to be connected locally.
\r
4955 The second form of TALK is used when other cluster nodes are connected
\r
4956 with restricted information. This usually means that they don't send
\r
4957 the user information usually associated with logging on and off the cluster.
\r
4959 If you know that G3JNB is likely to be present on GB7TLH, but you can only
\r
4960 see GB7TLH in the SH/C list but with no users, then you would use the
\r
4961 second form of the talk message.
\r
4963 If you want to have a ragchew with someone you can leave the text message
\r
4964 out and the system will go into 'Talk' mode. What this means is that a
\r
4965 short message is sent to the recipient telling them that you are in a 'Talking'
\r
4966 frame of mind and then you just type - everything you send will go to the
\r
4967 station that you asked for.
\r
4969 All the usual announcements, spots and so on will still come out on your
\r
4972 If you want to do something (such as send a spot) you precede the normal
\r
4973 command with a '/' character, eg:-
\r
4976 /DX 14001 G1TLH What's a B class licensee doing on 20m CW?
\r
4980 To leave talk mode type:
\r
4990 <bf>type <filearea>/<name></bf> Look at a file in one of the fileareas
\r
4994 Type out the contents of a file in a filearea. So, for example, in
\r
4995 filearea 'bulletins' you want to look at file 'arld051' you would
\r
4999 TYPE bulletins/arld051
\r
5002 See also SHOW/FILES to see what fileareas are available and a
\r
5009 <bf>who</bf> Show who is physically connected locally
\r
5013 This is a quick listing that shows which callsigns are connected and
\r
5014 what sort of connection they have
\r
5020 <bf>wx <text></bf> Send a weather message to local users<newline>
\r
5021 <bf>wx full <text> </bf> Send a weather message to all cluster users
\r
5025 Weather messages can sometimes be useful if you are experiencing an extreme
\r
5026 that may indicate enhanced conditions
\r
5028 <sect1>wx (enhanced for sysops) (5)
\r
5032 <bf>wx sysop <text></bf> Send a weather message to other clusters only
\r
5036 Send a weather message only to other cluster nodes and not to general users.
\r
projects / spider.git / blob