updated documentation a bit
[spider.git] / cmd / Commands_en.hlp
index 6f04e71d321a3e8578f894ccb5cc5c6f50cb0c15..10a4805cd2261165f0c5cb239fc86428ad8dc285 100644 (file)
@@ -23,12 +23,12 @@ You can use any of the following things in this line:-
   info <string>            eg: iota or qsl
   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>
+  origin_dxcc <prefixes or numbers>    eg: 61,62 (from eg: sh/pre G)
+  origin_itu <prefixes or numbers>     or: G,GM,GW
+  origin_zone <prefixes or numbers>
+  by_dxcc <prefixes or numbers>
+  by_itu <prefixes or numbers>
+  by_zone <prefixes or numbers>
   channel <prefixes>
   wx 1                     filter WX announces
   dest <prefixes>          eg: 6MUK,WDX      (distros)
@@ -65,13 +65,13 @@ 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:-
 
   call <prefixes>        the callsign of the thingy
-  call_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
-  call_itu <numbers>
-  call_zone <numbers>
+  call_dxcc <prefixes or numbers>    eg: 61,62 (from eg: sh/pre G)
+  call_itu <prefixes or numbers>     or: G,GM,GW
+  call_zone <prefixes or numbers>
   origin <prefixes>      really the interface it came in on
-  origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
-  origin_itu <numbers>
-  origin_zone <numbers>
+  origin_dxcc <prefixes or numbers>    eg: 61,62 (from eg: sh/pre G)
+  origin_itu <prefixes or numbers>     or: G,GM,GW
+  origin_zone <prefixes or numbers>
 
 some examples:-
 
@@ -97,12 +97,12 @@ You can use any of the following things in this line:-
   call <prefixes>        eg: G,PA,HB9
   info <string>          eg: iota or qsl
   by <prefixes>            
-  call_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
-  call_itu <numbers>
-  call_zone <numbers>
-  by_dxcc <numbers>
-  by_itu <numbers>
-  by_zone <numbers>
+  call_dxcc <prefixes or numbers>    eg: 61,62 (from eg: sh/pre G)
+  call_itu <prefixes or numbers>     or: G,GM,GW
+  call_zone <prefixes or numbers>
+  by_dxcc <prefixes or numbers>
+  by_itu <prefixes or numbers>
+  by_zone <prefixes or numbers>
   origin <prefixes>
   channel <prefixes>
 
@@ -140,12 +140,12 @@ 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>
+  origin_dxcc <prefixes or numbers>    eg: 61,62 (from eg: sh/pre G)
+  origin_itu <prefixes or numbers>     or: G,GM,GW
+  origin_zone <prefixes or numbers>
+  by_dxcc <prefixes or numbers>
+  by_itu <prefixes or numbers>
+  by_zone <prefixes or numbers>
   channel <prefixes>
 
 There are no examples because WCY Broadcasts only come from one place and
@@ -168,12 +168,12 @@ 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>
+  origin_dxcc <prefixes or numbers>    eg: 61,62 (from eg: sh/pre G)
+  origin_itu <prefixes or numbers>     or: G,GM,GW
+  origin_zone <prefixes or numbers>
+  by_dxcc <prefixes or numbers>
+  by_itu <prefixes or numbers>
+  by_zone <prefixes or numbers>
   channel <prefixes>
 
 for example 
@@ -207,6 +207,26 @@ This will send your announcement cluster wide
 Search the help database for <string> (it isn't case sensitive), and print
 the names of all the commands that may be relevant.
 
+=== 0^BLANK [<string>] [<nn>]^Print nn (default 1) blank lines (or strings)
+In its basic form this command prints one or more blank lines. However if
+you pass it a string it will replicate the string for the width of the 
+screen (default 80) and then print that one or more times, so:
+
+  blank 2
+
+prints two blank lines
+
+  blank - 
+
+prints a row of - characters once.
+
+  blank abc
+
+prints 'abcabcabcabcabcabc....'
+
+This is really only of any use in a script file and you can print a maximum
+of 9 lines.
+
 === 0^BYE^Exit from the cluster
 This will disconnect you from the cluster
 
@@ -231,7 +251,27 @@ which will arrange for them to be forward candidates again.
 
 Order is not important.
 
-=== 0^CLEAR/SPOTS [1|all]^Clear a spot filter line
+=== 0^CLEAR/ANNOUNCE [1|all]^Clear a announce filter line
+This command allows you to clear (remove) a line in a annouce filter or to 
+remove the whole filter.
+
+see CLEAR/SPOTS for a more detailed explanation.
+
+=== 8^CLEAR/ANNOUNCE [input] <callsign> [0-9|all]^Clear a announce filter line
+A sysop can clear an input or normal output filter for a user or the
+node_default or user_default. 
+
+=== 0^CLEAR/ROUTE [1|all]^Clear a route filter line
+This command allows you to clear (remove) a line in a route filter or to 
+remove the whole filter.
+
+see CLEAR/SPOTS for a more detailed explanation.
+
+=== 8^CLEAR/ROUTE [input] <callsign> [0-9|all]^Clear a route filter line
+A sysop can clear an input or normal output filter for a user or the
+node_default or user_default. 
+
+=== 0^CLEAR/SPOTS [0-9|all]^Clear a spot filter line
 This command allows you to clear (remove) a line in a spot filter or to 
 remove the whole filter.
 
@@ -254,14 +294,41 @@ If you do:
 
 the filter will be completely removed.
 
+=== 8^CLEAR/SPOTS [input] <callsign> [0-9|all]^Clear a spot filter line
+A sysop can clear an input or normal output filter for a user or the
+node_default or user_default. 
+
+=== 0^CLEAR/WCY [1|all]^Clear a WCY filter line
+This command allows you to clear (remove) a line in a WCY filter or to 
+remove the whole filter.
+
+see CLEAR/SPOTS for a more detailed explanation.
+
+=== 8^CLEAR/WCY [input] <callsign> [0-9|all]^Clear a WCY filter line
+A sysop can clear an input or normal output filter for a user or the
+node_default or user_default. 
+
+=== 0^CLEAR/WWV [1|all]^Clear a WWV filter line
+This command allows you to clear (remove) a line in a WWV filter or to 
+remove the whole filter.
+
+see CLEAR/SPOTS for a more detailed explanation.
+
+=== 8^CLEAR/WWV [input] <callsign> [0-9|all]^Clear a WWV filter line
+A sysop can clear an input or normal output filter for a user or the
+node_default or user_default. 
+
 === 5^CONNECT <callsign>^Start a connection to another DX Cluster
 Start a connection process that will culminate in a new connection to the
 DX cluster <callsign>. This process creates a new 'client' process which will
 use the script in /spider/connect/<callsign> to effect the 'chat' exchange
 necessary to traverse the network(s) to logon to the cluster <callsign>.
 
-=== 9^DELELE/USER <callsign> ...^Delete this user from the User Database
+=== 9^DELETE/USER <callsign> ...^Delete this user from the User Database
 This command will completely remove a one or more users from the database.
+
+There is NO SECOND CHANCE.
+
 It goes without saying that you should use this command CAREFULLY!
 
 === 0^DBAVAIL^Show a list of all the Databases in the system
@@ -559,6 +626,12 @@ To remove the filter in its entirty:-
 
   clear/spots all
 
+There are similar CLEAR commands for the other filters:-
+
+  clear/announce
+  clear/wcy
+  clear/wwv
+
 ADVANCED USERS:-
 
 Once you are happy with the results you get, you may like to experiment. 
@@ -780,12 +853,12 @@ You can use any of the following things in this line:-
   info <string>            eg: iota or qsl
   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>
+  origin_dxcc <prefixes or numbers>    eg: 61,62 (from eg: sh/pre G)
+  origin_itu <prefixes or numbers>     or: G,GM,GW
+  origin_zone <prefixes or numbers>
+  by_dxcc <prefixes or numbers>
+  by_itu <prefixes or numbers>
+  by_zone <prefixes or numbers>
   channel <prefixes>
   wx 1                     filter WX announces
   dest <prefixes>          eg: 6MUK,WDX      (distros)
@@ -822,12 +895,12 @@ You can use any of the following things in this line:-
   call <prefixes>        eg: G,PA,HB9
   info <string>          eg: iota or qsl
   by <prefixes>            
-  call_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
-  call_itu <numbers>
-  call_zone <numbers>
-  by_dxcc <numbers>
-  by_itu <numbers>
-  by_zone <numbers>
+  call_dxcc <prefixes or numbers>    eg: 61,62 (from eg: sh/pre G)
+  call_itu <prefixes or numbers>     or: G,GM,GW
+  call_zone <prefixes or numbers>
+  by_dxcc <prefixes or numbers>
+  by_itu <prefixes or numbers>
+  by_zone <prefixes or numbers>
   origin <prefixes>
   channel <prefixes>
 
@@ -858,13 +931,13 @@ read this 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:-
 
   call <prefixes>        the callsign of the thingy
-  call_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
-  call_itu <numbers>
-  call_zone <numbers>
+  call_dxcc <prefixes or numbers>    eg: 61,62 (from eg: sh/pre G)
+  call_itu <prefixes or numbers>     or: G,GM,GW
+  call_zone <prefixes or numbers>
   origin <prefixes>      really the interface it came in on
-  origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
-  origin_itu <numbers>
-  origin_zone <numbers>
+  origin_dxcc <prefixes or numbers>    eg: 61,62 (from eg: sh/pre G)
+  origin_itu <prefixes or numbers>     or: G,GM,GW
+  origin_zone <prefixes or numbers>
 
 some examples:-
 
@@ -890,12 +963,12 @@ 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>
+  origin_dxcc <prefixes or numbers>    eg: 61,62 (from eg: sh/pre G)
+  origin_itu <prefixes or numbers>     or: G,GM,GW
+  origin_zone <prefixes or numbers>
+  by_dxcc <prefixes or numbers>
+  by_itu <prefixes or numbers>
+  by_zone <prefixes or numbers>
   channel <prefixes>
 
 There are no examples because WCY Broadcasts only come from one place and
@@ -917,12 +990,12 @@ 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>
+  origin_dxcc <prefixes or numbers>    eg: 61,62 (from eg: sh/pre G)
+  origin_itu <prefixes or numbers>     or: G,GM,GW
+  origin_zone <prefixes or numbers>
+  by_dxcc <prefixes or numbers>
+  by_itu <prefixes or numbers>
+  by_zone <prefixes or numbers>
   channel <prefixes>
 
 for example 
@@ -984,16 +1057,31 @@ SP is an alias for SEND PRIVATE
 === 0^SET/ANNOUNCE^Allow announce messages to come out on your terminal
 === 0^UNSET/ANNOUNCE^Stop announce messages coming out on your terminal
 
+=== 0^SET/ANNTALK^Allow talk like announce messages on your terminal
+=== 0^UNSET/ANNTALK^Stop talk like announce messages on your terminal
+The announce system on legacy cluster nodes is used as a talk 
+substitute because the network is so poorly connected. If you:
+
+  unset/anntalk
+
+you will suppress several of these announces, you may miss the odd 
+useful one as well, but you would probably miss them anyway in the
+welter of useless ones.
+
+  set/anntalk 
+
+allows you to see them again. This is the default.
+
 === 5^SET/ARCLUSTER <call> [<call>..]^Make the callsign an AR-Cluster node
 
-=== 8^SET/BADDX <call>..^Stop words we do not wish to see in the callsign field
-of a dx spot being propagated
-=== 8^UNSET/BADDX <call>..^Allow a word to be seen again in a DX spot
-Setting a word as 'baddx' will prevent spots with that word in the 
-callsign field of a DX spot from going any further. They will not be 
-displayed and they will not be sent onto other nodes.
+=== 8^SET/BADDX <call>..^Stop callsigns in a dx spot being propagated
+=== 8^UNSET/BADDX <call>..^Propagate a dx spot with this callsign again
+Setting a word as 'baddx' will prevent spots with that word in the
+'spotted' field (as in: DX 14001.1 FR0G)of a DX spot from going any
+further. They will not be displayed and they will not be sent onto
+other nodes.
 
-The word must be wriiten in full, no wild cards are allowed eg:-
+The word must be written in full, no wild cards are allowed eg:-
 
   set/baddx FORSALE VIDEO FR0G
 
@@ -1039,6 +1127,23 @@ will allow spots from him again.
 
 Use with extreme care. This command may well be superceded by FILTERing.
 
+=== 8^SET/BADWORD <word>..^Stop things with this word being propagated
+=== 8^UNSET/BADWORD <word>..^Propagate things with this word again
+Setting a word as a 'badword' will prevent things like spots,
+announces or talks with this word in the the text part from going any
+further. They will not be displayed and they will not be sent onto
+other nodes.
+
+The word must be written in full, no wild cards are allowed eg:-
+
+  set/badword annihilate annihilated annihilation 
+
+will stop anything with these words in the text.
+
+  unset/badspotter annihilated
+
+will allow text with this word again.
+
 === 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
 
@@ -1091,7 +1196,7 @@ 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  
+=== 8^SET/HOPS <call> ann|spots|route|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 
@@ -1261,6 +1366,10 @@ for more information.
 Display all the bad spotter's callsigns in the system, see SET/BADSPOTTER
 for more information.
 
+=== 1^SHOW/BADWORD^Show all the bad words in the system
+Display all the bad words in the system, see SET/BADWORD
+for more information.
+
 === 0^SHOW/CONFIGURATION [<node>]^Show all the nodes and users visible
 This command allows you to see all the users that can be seen
 and the nodes to which they are connected.
@@ -1344,6 +1453,9 @@ e.g.
    SH/DXCC G
    SH/DXCC W on 20m info iota
 
+=== 0^SHOW/DXSTATS^Show the DX Statistics for last 31 days
+Show the total DX spots for the last 31 days
+
 === 0^SHOW/FILES [<filearea> [<string>]]^List the contents of a filearea
 SHOW/FILES on its own will show you a list of the various fileareas
 available on the system. To see the contents of a particular file
@@ -1362,10 +1474,13 @@ 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.
 
-=== 0^SHOW/HFSTATS^Show the HF DX Spot statistics
-Show the HF DX Spot statistics for your country for the last 31 days
+=== 0^SHOW/HFSTATS^Show the HF DX Statistics for last 31 days 
+Show the HF DX spots breakdown by band for the last 31 days
 
-=== 8^SHOW/HOPS <call> [ann|spots|wcy|wwv]^Show the hop counts for a node
+=== 0^SHOW/HFTABLE^Show the HF DX Spotter Table for your country
+Show the HF DX Spotter table for your country for the last 31 days
+
+=== 8^SHOW/HOPS <call> [ann|spots|route|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.
@@ -1566,8 +1681,11 @@ time and UTC as the computer has it right now. If you give some prefixes
 then it will show UTC and UTC + the local offset (not including DST) at
 the prefixes or callsigns that you specify.
 
-=== 0^SHOW/VHFSTATS^Show the VHF DX Spot statistics
-Show the VHF/UHF DX Spot statistics for your country for the last 31 days
+=== 0^SHOW/VHFSTATS^Show the VHF DX Statistics for last 31 days
+Show the VHF DX spots breakdown by band for the last 31 days
+
+=== 0^SHOW/VHFTABLE^Show the VHF DX Spotter Table for your country
+Show the VHF DX Spotter table for your country for the last 31 days
 
 === 0^SHOW/WCY^Show last 10 WCY broadcasts
 === 0^SHOW/WCY <n>^Show last <n> WCY broadcasts