Changes to manual namings to standardise. Added script from M0AZM to
[spider.git] / cmd / Commands_en.hlp
index ed1bbb89533544fc445306bc689f47dc282f4a86..48ae9f788bcde5280535350be40e83bbcde3a14e 100644 (file)
@@ -32,9 +32,11 @@ You can use any of the following things in this line:-
   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>
+  origin_state <states>                eg: VA,NH,RI,NH
   by_dxcc <prefixes or numbers>
   by_itu <prefixes or numbers>
   by_zone <prefixes or numbers>
+  by_state <states>
   channel <prefixes>
   wx 1                     filter WX announces
   dest <prefixes>          eg: 6MUK,WDX      (distros)
@@ -47,6 +49,10 @@ some examples:-
 or
   acc/ann by G,M,2 
 
+for american states
+
+  acc/ann by_state va,nh,ri,nh
+
 You can use the tag 'all' to accept everything eg:
 
   acc/ann all
@@ -74,16 +80,25 @@ You can use any of the following things in this line:-
   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>
+  call_state <states>                eg: VA,NH,RI,NH
   origin <prefixes>      really the interface it came in on
   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>
+  origin_state <states>                eg: VA,NH,RI,NH
 
 some examples:-
 
   acc/route gb7djk call_dxcc 61,38 (send only UK+EIRE nodes)
   acc/route gb7djk call gb7djk     (equiv to SET/ISOLATE)
 
+you can now use 'by' as a synonym for 'call' so:
+
+  by = call
+  by_dxcc = call_dxcc 
+
+and so on
+
 You can use the tag 'all' to accept everything eg:
 
   acc/route all
@@ -106,12 +121,16 @@ You can use any of the following things in this line:-
   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>
+  call_state <states>                eg: VA,NH,RI,ME
   by_dxcc <prefixes or numbers>
   by_itu <prefixes or numbers>
   by_zone <prefixes or numbers>
+  by_state <states>                eg: VA,NH,RI,ME
   origin <prefixes>
   channel <prefixes>
 
+'call' means the callsign that has spotted 'by' whoever.
+
 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 -
@@ -127,6 +146,10 @@ You can use the tag 'all' to accept everything, eg:
 
   acc/spot 3 all
 
+for US states 
+
+  acc/spots by_state VA,NH,RI,MA,ME
+
 but this probably for advanced users...
 
 
@@ -263,7 +286,7 @@ 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
+=== 8^CLEAR/ANNOUNCE <callsign> [input] [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. 
 
@@ -273,7 +296,7 @@ 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
+=== 8^CLEAR/ROUTE <callsign> [input] [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. 
 
@@ -300,7 +323,7 @@ If you do:
 
 the filter will be completely removed.
 
-=== 8^CLEAR/SPOTS [input] <callsign> [0-9|all]^Clear a spot filter line
+=== 8^CLEAR/SPOTS <callsign> [input] [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. 
 
@@ -310,7 +333,7 @@ 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
+=== 8^CLEAR/WCY <callsign> [input] [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. 
 
@@ -320,7 +343,7 @@ 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
+=== 8^CLEAR/WWV <callsign> [input] [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. 
 
@@ -330,6 +353,17 @@ 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^DELETE/USDB <callsign> ...^Delete this user from the US State Database
+This command will completely remove a one or more callsigns
+from the US States database.
+
+There is NO SECOND CHANCE.
+
+It goes without saying that you should use this command CAREFULLY!
+
+Note that these callsign may be re-instated by any weekly updates from 
+the FCC.
+
 === 9^DELETE/USER <callsign> ...^Delete this user from the User Database
 This command will completely remove a one or more users from the database.
 
@@ -598,7 +632,7 @@ 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
+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:-
@@ -625,6 +659,10 @@ you are confortable with the way it works. Yes, you can mix them
 don't try this at home until you can analyse the results that you get
 without ringing up the sysop for help.
 
+Another useful addition now is filtering by US state
+
+  accept/spots by_state VA,NH,RI,ME
+
 You can arrange your filter lines into logical units, either for your
 own understanding or simply convenience. I have one set frequently:-
 
@@ -729,7 +767,7 @@ node>).
 
 Best of luck - you will need it.
   
-=== 9^DEMOSTRATE <call> <command>^Demonstrate a command to another user
+=== 9^DEMONSTRATE <call> <command>^Demonstrate a command to another user
 This command is provided so that sysops can demonstrate commands to 
 other users. It runs a command as though that user had typed it in and
 then sends the output to that user, together with the command that 
@@ -954,9 +992,11 @@ You can use any of the following things in this line:-
   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>
+  origin_state <states>                eg: VA,NH,RI,ME
   by_dxcc <prefixes or numbers>
   by_itu <prefixes or numbers>
   by_zone <prefixes or numbers>
+  by_state <states>                eg: VA,NH,RI,ME
   channel <prefixes>
   wx 1                     filter WX announces
   dest <prefixes>          eg: 6MUK,WDX      (distros)
@@ -996,12 +1036,16 @@ You can use any of the following things in this line:-
   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>
+  call_state <states>                eg: VA,NH,RI,ME
   by_dxcc <prefixes or numbers>
   by_itu <prefixes or numbers>
   by_zone <prefixes or numbers>
+  by_state <states>                eg: VA,NH,RI,ME
   origin <prefixes>
   channel <prefixes>
 
+'call' means the callsign that has spotted 'by' whoever.
 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 -
@@ -1032,10 +1076,12 @@ You can use any of the following things in this line:-
   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>
+  call_state <states>                eg: VA,NH,RI,ME
   origin <prefixes>      really the interface it came in on
   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>
+  origin_state <states>                eg: VA,NH,RI,ME
 
 some examples:-
 
@@ -1045,6 +1091,8 @@ You can use the tag 'all' to reject everything eg:
 
   rej/route all     (equiv to [very] restricted mode)
 
+as with ACCEPT/ROUTE 'by' is now a synonym for 'call'.
+
 === 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:-
@@ -1305,8 +1353,10 @@ The call must be written in full, no wild cards are allowed eg:-
 
   set/badspotter VE2STN 
 
-will stop anything from VE2STN. If you want SSIDs as well then you must
-enter them specifically.
+will stop anything from VE2STN. This command will automatically
+stop spots from this user, regardless of whether or which SSID 
+he uses. DO NOT USE SSIDs in the callsign, just use the callsign
+as above or below.
 
   unset/badspotter VE2STN
 
@@ -1342,11 +1392,11 @@ will allow text with this word again.
 === 9^UNSET/DEBUG <name>^Remove a debug level from the debug set
 You can choose to log several different levels.  The levels are
 
-chan
-state
-msg
-cron
-connect
+ chan
+ state
+ msg
+ cron
+ connect
 
 You can show what levels you are logging with SHOW/DEBUG
 
@@ -1454,7 +1504,7 @@ Tell the system what your name is eg:-
 Tell the system that the call(s) are to be treated as AK1A cluster and
 fed PC Protocol rather normal user commands.
 
-=== 8^SET/OBSCOUNT <count> <nodecall>^Set the 'pump-up' obscelence counter 
+=== 8^SET/OBSCOUNT <count> <call>^Set the 'pump-up' obscelence PING counter 
 From 1.35 onwards neighbouring nodes are pinged at regular intervals (see
 SET/PINGINTERVAL), usually 300 seconds or 5 minutes. There is a 'pump-up'
 counter which is decremented on every outgoing ping and then reset to
@@ -1609,6 +1659,15 @@ SEND messages to the sysop.
 === 0^SET/TALK^Allow TALK messages to come out on your terminal
 === 0^UNSET/TALK^Stop TALK messages coming out on your terminal
 
+=== 9^SET/USDB <call> <state> <city>^add/update a US DB callsign
+This command allows you to add or alter a callsign in the US state
+database. Use with extreme caution. Anything you do here will be
+overwritten by any weekly updates that affect this callsign
+
+  set/usdb g1tlh nh downtown rindge
+
+see also DELETE/USDB
+
 === 0^SET/WCY^Allow WCY messages to come out on your terminal
 === 0^UNSET/WCY^Stop WCY messages coming out on your terminal
 
@@ -1640,8 +1699,23 @@ and the nodes to which they are connected.
 
 This command is normally abbreviated to: sh/c
 
+Normally, the list returned will be just for the nodes from your 
+country (because the list otherwise will be very long).
+
+  SH/C ALL 
+
+will produce a complete list of all nodes. 
+
 BE WARNED: the list that is returned can be VERY long
 
+It is possible to supply a node or part of a prefix and you will get 
+a list of the users for that node or list of nodes starting with
+that prefix.
+
+  SH/C GB7DJK
+
+  SH/C SK
+
 === 0^SHOW/CONFIGURATION/NODE^Show all the nodes connected locally
 Show all the nodes connected to this node.
 
@@ -1667,47 +1741,47 @@ If you just type SHOW/DX you will get the last so many spots
 In addition you can add any number of these commands in very nearly
 any order to the basic SHOW/DX command, they are:-
    
-on <band>       - eg 160m 20m 2m 23cm 6mm
-on <region>     - eg hf vhf uhf shf      (see SHOW/BANDS)
-on <from>/<to>  - eg 1000/4000 14000-30000  (in Khz)
-   <from>-<to>
+ on <band>       - eg 160m 20m 2m 23cm 6mm
+ on <region>     - eg hf vhf uhf shf      (see SHOW/BANDS)
+ on <from>/<to>  - eg 1000/4000 14000-30000  (in Khz)
+    <from>-<to>
    
-<number>        - the number of spots you want
-<from>-<to>     - <from> spot no <to> spot no in the selected list
-<from>/<to>
+ <number>        - the number of spots you want
+ <from>-<to>     - <from> spot no <to> spot no in the selected list
+ <from>/<to>
    
-<prefix>        - for a spotted callsign beginning with <prefix>
-*<suffix>       - for a spotted callsign ending in <suffix>
-*<string>*      - for a spotted callsign containing <string>
+ <prefix>        - for a spotted callsign beginning with <prefix>
+ *<suffix>       - for a spotted callsign ending in <suffix>
+ *<string>*      - for a spotted callsign containing <string>
    
-day <number>    - starting <number> days ago
-day <from>-<to> - <from> days <to> days ago
-    <from>/<to>   
+ day <number>    - starting <number> days ago
+ day <from>-<to> - <from> days <to> days ago
+     <from>/<to>   
 
-info <text>     - any spots containing <text> in the info or remarks
-   
-by <call>       - any spots spotted by <call> (spotter <call> is the 
-                  same).
+ info <text>     - any spots containing <text> in the info or remarks
+    
+ by <call>       - any spots spotted by <call> (spotter <call> is the 
+                   same).
 
-qsl             - this automatically looks for any qsl info on the call
-                  held in the spot database.
+ qsl             - this automatically looks for any qsl info on the call
+                   held in the spot database.
 
-iota [<iota>]   - If the iota island number is missing it will look for
+ iota [<iota>]   - If the iota island number is missing it will look for
                   the string iota and anything which looks like an iota
                   island number. If you specify then it will look for  
                   that island.
 
-qra [<locator>] - this will look for the specific locator if you specify
-                  one or else anything that looks like a locator.
+ qra [<locator>] - this will look for the specific locator if you specify
+                   one or else anything that looks like a locator.
 
-dxcc            - treat the prefix as a 'country' and look for spots
-                  from that country regardless of actual prefix.
-                  eg dxcc oq2 
+ dxcc            - treat the prefix as a 'country' and look for spots
+                   from that country regardless of actual prefix.
+                   eg dxcc oq2 
                   
-                  You can also use this with the 'by' keyword so 
-                  eg by W dxcc  
+                   You can also use this with the 'by' keyword so 
+                   eg by W dxcc  
    
-e.g. 
+ e.g. 
    
    SH/DX 9m0
    SH/DX on 20m info iota
@@ -1737,8 +1811,9 @@ This can be done with the SHOW/DX command like this:-
    SH/DX dxcc g
    SH/DX dxcc w on 20m iota
 
-=== 0^SHOW/DXSTATS^Show the DX Statistics for last 31 days
-Show the total DX spots for the last 31 days
+=== 0^SHOW/DXSTATS [days] [date]^Show the DX Statistics
+Show the total DX spots for the last <days> no of days (default is 31), 
+starting from a <date> (default: today).
 
 === 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
@@ -1758,11 +1833,45 @@ 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 Statistics for last 31 days 
-Show the HF DX spots breakdown by band for the last 31 days
+=== 0^SHOW/HFSTATS [days] [date]^Show the HF DX Statistics 
+Show the HF DX spots breakdown by band for the last <days> no of days 
+(default is 31), starting from a <date> (default: today).
+
+=== 0^SHOW/HFTABLE [days] [date] [prefix ...]^Show the HF DX Spotter Table
+Show the HF DX Spotter table for the list of prefixes for the last 
+<days> no of days (default is 31), starting from a <date> (default: today).
+
+If there are no prefixes then it will show the table for your country.
+
+Remember that some countries have more than one "DXCC country" in them
+(eg G :-), to show them (assuming you are not in G already which is
+specially treated in the code) you must list all the relevant prefixes
+
+  sh/hftable g gm gd gi gj gw gu 
+
+Note that the prefixes are converted into country codes so you don't have
+to list all possible prefixes for each country.
+
+If you want more or less days than the default simply include the
+number you require:-
+
+  sh/hftable 20 pa
+
+If you want to start at a different day, simply add the date in some 
+recognizable form:-
+
+  sh/hftable 2 25nov02
+  sh/hftable 2 25-nov-02 
+  sh/hftable 2 021125 
+  sh/hftable 2 25/11/02
+
+This will show the stats for your DXCC for that CQWW contest weekend. 
+
+You can specify either prefixes or full callsigns (so you can see how you
+did against all your mates). You can also say 'all' which will then print
+the worldwide statistics.
 
-=== 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
+  sh/hftable all 
 
 === 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
@@ -1916,8 +2025,8 @@ distance and bearing between two locators or (if only one locator is
 given on the command line) the distance and beraing from your station
 to the locator. For example:-
 
-SH/QRA IO92QL 
-SH/QRA JN06 IN73
+ SH/QRA IO92QL 
+ SH/QRA JN06 IN73
 
 The first example will show the distance and bearing to the locator from
 yourself, the second example will calculate the distance and bearing from
@@ -1927,7 +2036,7 @@ It is also possible to convert a latitude and longitude to a locator by
 using this command with a latitude and longitude as an argument, for
 example:-
 
-SH/QRA 52 41 N 0 58 E
+ 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
@@ -1940,7 +2049,7 @@ is provided for users of this software by http://www.qrz.com
 This command allows you to see to which node the callsigns specified are
 connected. It is a sort of inverse sh/config.
 
-sh/route n2tly
+ sh/route n2tly
 
 === 0^SHOW/SATELLITE <name> [<hours> <interval>]^Show tracking data
 Show the tracking data from your location to the satellite of your choice
@@ -1960,8 +2069,8 @@ Each pass in a period is separated with a row of '-----' characters
 
 So for example:-
 
-SH/SAT AO-10 
-SH/SAT FENGYUN1 12 2
+ SH/SAT AO-10 
+ SH/SAT FENGYUN1 12 2
 
 === 6^SHOW/STATION ALL [<regex>]^Show list of users in the system
 === 0^SHOW/STATION [<callsign> ..]^Show information about a callsign
@@ -2009,11 +2118,51 @@ 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 Statistics for last 31 days
-Show the VHF DX spots breakdown by band for the last 31 days
+=== 0^SHOW/USDB [call ..]^Show information held on the FCC Call database
+Show the City and State of a Callsign held on the FCC database if
+his is being run on this system, eg:-
+
+  sh/usdb k1xx
+
+=== 0^SHOW/VHFSTATS [days] [date]^Show the VHF DX Statistics
+Show the VHF DX spots breakdown by band for the last 
+<days> no of days (default is 31), starting from a date (default: today).
+
+=== 0^SHOW/VHFTABLE [days] [date] [prefix ...]^Show the VHF DX Spotter Table
+Show the VHF DX Spotter table for the list of prefixes for the last 
+<days> no of days (default is 31), starting from a date (default: today).
+
+If there are no prefixes then it will show the table for your country.
+
+Remember that some countries have more than one "DXCC country" in them
+(eg G :-), to show them (assuming you are not in G already which is
+specially treated in the code) you must list all the relevant prefixes
+
+  sh/vhftable g gm gd gi gj gw gu 
+
+Note that the prefixes are converted into country codes so you don't have
+to list all possible prefixes for each country.
+
+If you want more or less days than the default simply include the
+number you require:-
+
+  sh/vhftable 20 pa
+
+If you want to start at a different day, simply add the date in some 
+recognizable form:-
+
+  sh/vhftable 2 25nov02
+  sh/vhftable 2 25-nov-02 
+  sh/vhftable 2 021125 
+  sh/vhftable 2 25/11/02
+
+This will show the stats for your DXCC for that CQWW contest weekend. 
+
+You can specify either prefixes or full callsigns (so you can see how you
+did against all your mates). You can also say 'all' which will then print
+the worldwide statistics.
 
-=== 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
+  sh/vhftable all 
 
 === 0^SHOW/WCY^Show last 10 WCY broadcasts
 === 0^SHOW/WCY <n>^Show last <n> WCY broadcasts