add help for wwv and wcy filter commands
[spider.git] / cmd / Commands_en.hlp
index 971765143762bae70c641a083b8f242e3b0aea51..c2004168a137c6d57d0aa1bf5ab33cae1b751f88 100644 (file)
@@ -41,10 +41,12 @@ some examples:-
 or
   acc/ann by G,M,2 
 
-You can use the tag 'all' to reject everything that is left, eg:
+You can use the tag 'all' to accept everything eg:
 
   acc/ann all
 
+but this probably for advanced users...
+
 === 8^ACCEPT/ANNOUNCE <call> [input] [0-9] <pattern>^Announce filter sysop version
 This version allows a sysop to set a filter for a callsign as well as the
 default for nodes and users eg:-
@@ -63,6 +65,7 @@ to understand how filters work - it will save a lot of grief later on.
 You can use any of the following things in this line:-
 
   freq <range>           eg: 0/30000 or hf or hf/cw or 6m,4m,2m
+  on <range>             same as 'freq'
   call <prefixes>        eg: G,PA,HB9
   info <string>          eg: iota or qsl
   by <prefixes>            
@@ -75,15 +78,23 @@ You can use any of the following things in this line:-
   origin <prefixes>
   channel <prefixes>
 
+For frequencies, you can use any of the band names defined in
+SHOW/BANDS and you can use a subband name like: cw, rtty, data, ssb -
+thus: hf/ssb. You can also just have a simple range like: 0/30000 -
+this is more efficient than saying simply: freq HF (but don't get
+too hung up about that)
+
 some examples:-
 
   acc/spot 1 freq hf/cw
   acc/spot 2 freq vhf and (by_zone 14,15,16 or call_zone 14,15,16)
 
-You can use the tag 'all' to reject everything that is left, eg:
+You can use the tag 'all' to accept everything, eg:
 
   ann/spot 3 all
 
+but this probably for advanced users...
+
 === 8^ACCEPT/SPOTS <call> [input] [0-9] <pattern>^Spot filter sysop version
 This version allows a sysop to set a filter for a callsign as well as the
 default for nodes and users eg:-
@@ -94,6 +105,67 @@ default for nodes and users eg:-
 
   accept/spot user_default by G,M,2
 
+=== 0^ACCEPT/WCY [0-9] <pattern>^set an 'accept' WCY filter
+It is unlikely that you will want to do this, but if you do then you can
+filter on the following fields:-
+
+  by <prefixes>            eg: G,M,2         
+  origin <prefixes>
+  origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
+  origin_itu <numbers>
+  origin_zone <numbers>
+  by_dxcc <numbers>
+  by_itu <numbers>
+  by_zone <numbers>
+  channel <prefixes>
+
+There are no examples because WCY Broadcasts only come from one place and
+you either want them or not (see UNSET/WCY if you don't want them).
+
+This command is really provided for future use.
+
+See HELP FILTER for information.
+
+=== 8^ACCEPT/WCY <call> [input] [0-9] <pattern>^WCY filter sysop version
+This version allows a sysop to set a filter for a callsign as well as the
+default for nodes and users eg:-
+
+  accept/wcy node_default all
+  set/hops node_default 10
+
+=== 0^ACCEPT/WWV [0-9] <pattern>^set an 'accept' WWV filter
+It is unlikely that you will want to do this, but if you do then you can
+filter on the following fields:-
+
+  by <prefixes>            eg: G,M,2         
+  origin <prefixes>
+  origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
+  origin_itu <numbers>
+  origin_zone <numbers>
+  by_dxcc <numbers>
+  by_itu <numbers>
+  by_zone <numbers>
+  channel <prefixes>
+
+for example 
+
+  accept/wwv by_zone 4
+
+is probably the only useful thing to do (which will only show WWV broadcasts
+by stations in the US).
+
+See HELP FILTER for information.
+
+=== 8^ACCEPT/WWV <call> [input] [0-9] <pattern>^WWV filter sysop version
+This version allows a sysop to set a filter for a callsign as well as the
+default for nodes and users eg:-
+
+  accept/wwv db0sue-7 1 by_zone 4
+  accept/wwv node_default all
+  set/hops node_default 10
+
+  accept/wwv user_default by W,K
+
 === 0^ANNOUNCE <text>^Send an announcement to LOCAL users only
 <text> is the text of the announcement you wish to broadcast 
 
@@ -352,18 +424,19 @@ made on the filename (if any) that you specify.
 There are a number of things you can filter in the DXSpider system. They
 all use the same general mechanism.
 
-In general terms you can create a 'reject' or an 'accept' filter which can
-have up to 10 lines in it. You do this using, for example:-
+In general terms you can create a 'reject' or an 'accept' filter which
+can have up to 10 lines in it. You do this using, for example:-
  
   accept/spots .....
   reject/spots .....
 
-where ..... are the specific commands for that type of filter. There are 
-filters for spots, wwv, announce, wcy and (for sysops) connects. See each
-different accept or reject command reference for more details.
+where ..... are the specific commands for that type of filter. There
+are filters for spots, wwv, announce, wcy and (for sysops)
+connects. See each different accept or reject command reference for
+more details.
 
-There is also a command to clear out one or more lines in a filter and one
-to show you what you have set. They are:-
+There is also a command to clear out one or more lines in a filter and
+one to show you what you have set. They are:-
 
   clear/spots 1
   clear/spots all
@@ -374,25 +447,26 @@ and
 
 There is clear/xxxx command for each type of filter.
 
-For now we are going to use spots for the examples, but you can apply the 
-principles to all types of filter. 
+For now we are going to use spots for the examples, but you can apply
+the principles to all types of filter.
 
-There are two main types of filter 'accept' or 'reject'; which you use depends
-entirely on how you look at the world and what is least writing to achieve 
-what you want. Each filter has 10 lines (of any length) which are tried in 
-order. If a line matches then the action you have specified is taken (ie reject
-means ignore it and accept means gimme it).
+There are two main types of filter 'accept' or 'reject'; which you use
+depends entirely on how you look at the world and what is least
+writing to achieve what you want. Each filter has 10 lines (of any
+length) which are tried in order. If a line matches then the action
+you have specified is taken (ie reject means ignore it and accept
+means gimme it).
 
-The important thing to remember is that if you specify a 'reject' filter (all
-the lines in it say 'reject/spots' (for instance) then if a spot comes in that
-doesn't match any of the lines then you will get it BUT if you specify an
-'accept' filter then any spots that don't match are dumped. For example if I 
-have a one line accept filter:-
+The important thing to remember is that if you specify a 'reject'
+filter (all the lines in it say 'reject/spots' (for instance) then if
+a spot comes in that doesn't match any of the lines then you will get
+it BUT if you specify an 'accept' filter then any spots that don't
+match are dumped. For example if I have a one line accept filter:-
 
   accept/spots freq vhf and (by_zone 14,15,16 or call_zone 14,15,16)
 
-then automatically you will ONLY get VHF spots from or to CQ zones 14 15 and 16.
-If you set a reject filter like:
+then automatically you will ONLY get VHF spots from or to CQ zones 14
+15 and 16.  If you set a reject filter like:
 
   reject/spots freq hf/cw
 
@@ -405,35 +479,38 @@ But in that case you might only be interested in iota and say:-
 
   accept/spots not freq hf/cw or info iota
 
-which is exactly the same. You should choose one or the other until you are
-confortable with the way it works. Yes, you can mix them (actually you can
-have an accept AND a reject on the same line) but don't try this at home
-until you can analyse the results that you get without ringing up the sysop
-for help.
+which is exactly the same. You should choose one or the other until
+you are confortable with the way it works. Yes, you can mix them
+(actually you can have an accept AND a reject on the same line) but
+don't try this at home until you can analyse the results that you get
+without ringing up the sysop for help.
 
-You can arrange your filter lines into logical units, either for your own 
-understanding or simply convenience. I have one set frequently:-
+You can arrange your filter lines into logical units, either for your
+own understanding or simply convenience. I have one set frequently:-
 
   reject/spots 1 freq/cw
   reject/spots 2 freq 50000/1400000 not (by_zone 14,15,16 or call_zone 14,15,16)  
 
-What this does is to ignore all HF CW spots (being a class B I can't read
-any CW and couldn't possibly be interested in HF :-) and also rejects any
-spots on VHF which don't either originate or spot someone in Europe.
+What this does is to ignore all HF CW spots (being a class B I can't
+read any CW and couldn't possibly be interested in HF :-) and also
+rejects any spots on VHF which don't either originate or spot someone
+in Europe.
 
-This is an exmaple where you would use the line number (1 and 2 in this case),
-if you leave the digit out, the system assumes '1'. Digits '0'-'9' are 
-available.
+This is an exmaple where you would use the line number (1 and 2 in
+this case), if you leave the digit out, the system assumes '1'. Digits
+'0'-'9' are available.
 
-You can leave the word 'and' out if you want, it is implied. You can use any 
-number of brackets to make the 'expression' as you want it. There are things
-called precedence rules working here which mean that you will NEED brackets 
-in a situation like line 2 because, without it, will assume:-
+You can leave the word 'and' out if you want, it is implied. You can
+use any number of brackets to make the 'expression' as you want
+it. There are things called precedence rules working here which mean
+that you will NEED brackets in a situation like line 2 because,
+without it, will assume:-
 
   (freq 50000/1400000 and by_zone 14,15,16) or call_zone 14,15,16 
 
-annoying, but that is the way it is. If you use OR - use brackets. Whilst we
-are here CASE is not important. 'And BY_Zone' is just 'and by_zone'.
+annoying, but that is the way it is. If you use OR - use
+brackets. Whilst we are here CASE is not important. 'And BY_Zone' is
+just 'and by_zone'.
 
 If you want to alter your filter you can just redefine one or more
 lines of it or clear out one line. For example:-
@@ -448,6 +525,28 @@ To remove the filter in its entirty:-
 
   clear/spots all
 
+ADVANCED USERS:-
+
+Once you are happy with the results you get, you may like to experiment. 
+
+my example that filters hf/cw spots and accepts vhf/uhf spots from EU
+can be written with a mixed filter, eg:
+
+  rej/spot freq hf/cw
+  acc/spot freq 0/30000
+  acc/spot 2 freq 50000/1400000 and (by_zone 14,15,16 or call_zone 14,15,16)
+
+each filter slot actually has a 'reject' slot and an 'accept'
+slot. The reject slot is executed BEFORE the accept slot.
+
+It was mentioned earlier that after a reject test that doesn't match,
+the default for following tests is 'accept', the reverse is true for
+'accept'. In the example what happens is that the reject is executed
+first, any non hf/cw spot is passed to the accept line, which lets
+thru everything else on HF.
+
+The next filter line lets through just VHF/UHF spots from EU.
+
 === 1^FORWARD/OPERNAM <call>^Send out information on this <call> to all clusters
 This command sends out any information held in the user file which can 
 be broadcast in PC41 protocol packets. This information is Name, QTH, Location
@@ -662,10 +761,12 @@ some examples:-
 
   rej/ann by_zone 14,15,16 and not by G,M,2
  
-You can use the tag 'all' to reject everything that is left, eg:
+You can use the tag 'all' to reject everything eg:
 
   rej/ann all
 
+but this probably for advanced users...
+
 === 8^REJECT/ANNOUNCE <call> [input] [0-9] <pattern>^Announce filter sysop version
 This version allows a sysop to set a filter for a callsign as well as the
 default for nodes and users eg:-
@@ -684,6 +785,7 @@ to understand how filters work - it will save a lot of grief later on.
 You can use any of the following things in this line:-
 
   freq <range>           eg: 0/30000 or hf or hf/cw or 6m,4m,2m
+  on <range>             same as 'freq'
   call <prefixes>        eg: G,PA,HB9
   info <string>          eg: iota or qsl
   by <prefixes>            
@@ -696,15 +798,23 @@ You can use any of the following things in this line:-
   origin <prefixes>
   channel <prefixes>
 
+For frequencies, you can use any of the band names defined in
+SHOW/BANDS and you can use a subband name like: cw, rtty, data, ssb -
+thus: hf/ssb. You can also just have a simple range like: 0/30000 -
+this is more efficient than saying simply: freq HF (but don't get
+too hung up about that)
+
 some examples:-
 
   rej/spot 1 freq hf
   rej/spot 2 freq vhf and not (by_zone 14,15,16 or call_zone 14,15,16)
 
-You can use the tag 'all' to reject everything that is left, eg:
+You can use the tag 'all' to reject everything eg:
 
   rej/spot 3 all
 
+but this probably for advanced users...
+
 === 8^REJECT/SPOTS <call> [input] [0-9] <pattern>^Spot filter sysop version
 This version allows a sysop to set a filter for a callsign as well as the
 default for nodes and users eg:-
@@ -715,6 +825,65 @@ default for nodes and users eg:-
 
   reject/spot user_default by G,M,2
 
+=== 0^REJECT/WCY [0-9] <pattern>^set an 'reject' WCY filter
+It is unlikely that you will want to do this, but if you do then you can
+filter on the following fields:-
+
+  by <prefixes>            eg: G,M,2         
+  origin <prefixes>
+  origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
+  origin_itu <numbers>
+  origin_zone <numbers>
+  by_dxcc <numbers>
+  by_itu <numbers>
+  by_zone <numbers>
+  channel <prefixes>
+
+There are no examples because WCY Broadcasts only come from one place and
+you either want them or not (see UNSET/WCY if you don't want them).
+
+This command is really provided for future use.
+
+See HELP FILTER for information.
+
+=== 8^REJECT/WCY <call> [input] [0-9] <pattern>^WCY filter sysop version
+This version allows a sysop to set a filter for a callsign as well as the
+default for nodes and users eg:-
+
+  reject/wcy gb7djk all
+
+=== 0^REJECT/WWV [0-9] <pattern>^set an 'reject' WWV filter
+It is unlikely that you will want to do this, but if you do then you can
+filter on the following fields:-
+
+  by <prefixes>            eg: G,M,2         
+  origin <prefixes>
+  origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
+  origin_itu <numbers>
+  origin_zone <numbers>
+  by_dxcc <numbers>
+  by_itu <numbers>
+  by_zone <numbers>
+  channel <prefixes>
+
+for example 
+
+  reject/wwv by_zone 14,15,16
+
+is probably the only useful thing to do (which will only show WWV broadcasts
+by stations in the US).
+
+See HELP FILTER for information.
+
+=== 8^REJECT/WWV <call> [input] [0-9] <pattern>^WWV filter sysop version
+This version allows a sysop to set a filter for a callsign as well as the
+default for nodes and users eg:-
+
+  reject/wwv db0sue-7 1 by_zone 4
+  reject/wwv node_default all
+
+  reject/wwv user_default by W
+
 === 0^REPLY^Reply (privately) to the last message that you have read
 === 0^REPLY <msgno>^Reply (privately) to the specified message
 === 0^REPLY B <msgno>^Reply as a Bulletin to the specified message
@@ -758,6 +927,24 @@ SP is an alias for SEND PRIVATE
 
 === 5^SET/ARCLUSTER <call> [<call>..]^Make the callsign an AR-Cluster node
 
+=== 6^SET/BADNODE <call>^Stop spots from this callsign being propagated
+=== 6^UNSET/BADNODE <call>^Allow spots from this callsign again
+Setting a callsign as a 'badnode' will prevent spots from that node 
+going any further. They will not be displayed and they will not be 
+sent onto other nodes.
+
+The call can be a full or partial call (or a prefix), eg:-
+
+  set/badnode K1TTT 
+
+will stop anything from K1TTT (including any SSID's)
+
+  unset/badnode K1TTT
+
+will allow spots from him again.
+
+Use with extreme care. This command may well be superceeded by FILTERing.
+
 === 0^SET/BEEP^Add a beep to DX and other messages on your terminal
 === 0^UNSET/BEEP^Stop beeps for DX and other messages on your terminal
 
@@ -799,6 +986,19 @@ to you will normally find their way there should you not be connected.
 eg:-
   SET/HOMENODE gb7djk
 
+=== 8^SET/HOPS <call> ann|spots|wwv|wcy <n>^Set hop count  
+Set the hop count for a particular type of broadcast for a node.
+
+This command allows you to set up special hop counts for a node 
+for currently: announce, spots, wwv and wcy broadcasts.
+
+eg:
+  set/hops gb7djk ann 10
+  set/hops gb7mbc spots 20
+
+Set SHOW/HOPS for information on what is already set. This command
+creates a filter and works in conjunction with the filter system. 
+
 === 9^SET/ISOLATE^Isolate a node from the rest of the network
 Connect a node to your system in such a way that you are a full protocol
 member of its network and can see all spots on it, but nothing either leaks
@@ -918,9 +1118,9 @@ Tell the system where you are. For example:-
 === 0^SET/WX^Allow WX messages to come out on your terminal
 === 0^UNSET/WX^Stop WX messages coming out on your terminal
 
-=== 0^SHOW/CALL <callsign>^Show any callbook details on a callsign
-This command queries an international callbook server on the internet
-and returns any information available for that callsign. 
+=== 6^SHOW/BADNODE^Show all the bad nodes in the system
+Display all the bad node callsigns in the system, see SET/BADNODE
+for more information.
 
 === 0^SHOW/DATE [<prefix>|<callsign>]^Show the local time 
 This is very nearly the same as SHOW/TIME, the only difference the format
@@ -1006,6 +1206,11 @@ See also TYPE - to see the contents of a file.
 Show the contents of all the filters that are set. This command displays
 all the filters set - for all the various categories.
 
+=== 8^SHOW/HOPS <call> [ann|spots|wcy|wwv]^Show the hop counts for a node
+This command shows the hop counts set up for a node. You can specify
+which category you want to see. If you leave the category out then 
+all the categories will be listed.
 === 1^SHOW/ISOLATE^Show list of ISOLATED nodes
 
 === 9^SHOW/LOCKOUT^Show the list of locked out or excluded callsigns
@@ -1133,6 +1338,11 @@ example:-
 
 SH/QRA 52 41 N 0 58 E
 
+=== 0^SHOW/QRZ <callsign>^Show any callbook details on a callsign
+This command queries the QRZ callbook server on the internet
+and returns any information available for that callsign. This service
+is provided for users of this software by http://www.qrz.com 
+
 === 0^SHOW/SATELLITE <name> [<hours> <interval>]^Show tracking data
 Show the tracking data from your location to the satellite of your choice
 from now on for the next few hours.