add various stats commands

[spider.git] / cmd / Commands_en.hlp

diff --git a/cmd/Commands_en.hlp b/cmd/Commands_en.hlp
index af5bcbd92179b607b01403728378d587f98504fa..3098cc296418a545e0c0208b01cf4f8e90a44fa3 100644 (file)
--- a/cmd/Commands_en.hlp
+++ b/cmd/Commands_en.hlp
@@ -55,6 +55,34 @@ default for nodes and users eg:-
   accept/ann input node_default by G,M,2
   accept/ann user_default by G,M,2
 
   accept/ann input node_default by G,M,2
   accept/ann user_default by G,M,2
 

+=== 8^ACCEPT/ROUTE <call> [0-9] <pattern>^Set an 'accept' filter line for routing
+Create an 'accept this routing PC Protocol' line for a filter. 
+
+An accept filter line means that if a PC16/17/19/21/24/41/50 matches this filter 
+it is passed thru that interface. See HELP FILTERING for more info. Please 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>
+  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>
+
+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 use the tag 'all' to accept everything eg:
+
+  acc/route all
+
+

 === 0^ACCEPT/SPOTS [0-9] <pattern>^Set an 'accept' filter line for spots
 Create an 'accept this spot' line for a filter. 
 
 === 0^ACCEPT/SPOTS [0-9] <pattern>^Set an 'accept' filter line for spots
 Create an 'accept this spot' line for a filter. 
 


@@ -95,6 +123,7 @@ You can use the tag 'all' to accept everything, eg:
 
 but this probably for advanced users...
 
 
 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:-
 === 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:-


@@ -231,6 +260,10 @@ 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>.
 
 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
+This command will completely remove a one or more users from the database.
+It goes without saying that you should use this command CAREFULLY!
+

 === 0^DBAVAIL^Show a list of all the Databases in the system
 Title says it all really, this command lists all the databases defined
 in the system. It is also aliased to SHOW/COMMAND.
 === 0^DBAVAIL^Show a list of all the Databases in the system
 Title says it all really, this command lists all the databases defined
 in the system. It is also aliased to SHOW/COMMAND.


@@ -815,6 +848,32 @@ You can use the tag 'all' to reject everything eg:
 
 but this probably for advanced users...
 
 
 but this probably for advanced users...
 

+=== 8^REJECT/ROUTE <call> [0-9] <pattern>^Set an 'reject' filter line for routing
+Create an 'reject this routing PC Protocol' line for a filter. 
+
+An reject filter line means that if a PC16/17/19/21/24/41/50 matches this filter 
+it is NOT passed thru that interface. See HELP FILTERING for more info. Please 
+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>
+  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>
+
+some examples:-
+
+  rej/route gb7djk call_dxcc 61,38 (everything except  UK+EIRE nodes)
+
+You can use the tag 'all' to reject everything eg:
+
+  rej/route all     (equiv to [very] restricted mode)
+

 === 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:-
 === 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:-


@@ -983,6 +1042,8 @@ Use with extreme care. This command may well be superceded 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
 
 === 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
 

+=== 5^SET/BBS <call> [<call>..]^Make the callsign a BBS
+

 === 5^SET/CLX <call> [<call>..]^Make the callsign an CLX node
 
 === 9^SET/DEBUG <name>^Add a debug level to the debug set
 === 5^SET/CLX <call> [<call>..]^Make the callsign an CLX node
 
 === 9^SET/DEBUG <name>^Add a debug level to the debug set


@@ -1149,6 +1210,12 @@ to commands are as default:-
 If you are a sysop and you come in as a normal user on a remote connection
 your privilege will automatically be set to 0.
 
 If you are a sysop and you come in as a normal user on a remote connection
 your privilege will automatically be set to 0.
 

+=== 0^UNSET/PRIVILEGE^Remove any privilege for this session
+You can use this command to 'protect' this session from unauthorised
+use. If you want to get your normal privilege back you will need to
+either logout and login again (if you are on a console) or use the
+SYSOP command.
+

 === 9^SET/PASSWORD <callsign> <string>^Set a users password
 The password for a user can only be set by a full sysop. The string
 can contain any characters but any spaces are removed (you can type in
 === 9^SET/PASSWORD <callsign> <string>^Set a users password
 The password for a user can only be set by a full sysop. The string
 can contain any characters but any spaces are removed (you can type in


@@ -1277,6 +1344,9 @@ e.g.
    SH/DXCC G
    SH/DXCC W on 20m info iota
 
    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
 === 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


@@ -1295,6 +1365,12 @@ 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.
 
 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/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|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 
 === 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 


@@ -1464,6 +1540,15 @@ 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
+Show the information known about a callsign and whether (and where)
+that callsign is connected to the cluster.
+
+  SH/ST G1TLH
+
+If no callsign is given then show the information for yourself.
+

 === 0^SHOW/SUN [<prefix>|<callsign>]^Show sun rise and set times
 Show the sun rise and set times for a (list of) prefixes or callsigns, 
 together with the azimuth and elevation of the sun currently at those
 === 0^SHOW/SUN [<prefix>|<callsign>]^Show sun rise and set times
 Show the sun rise and set times for a (list of) prefixes or callsigns, 
 together with the azimuth and elevation of the sun currently at those


@@ -1487,6 +1572,12 @@ 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.
 
 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/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
 Display the most recent WCY information that has been received by the system
 === 0^SHOW/WCY^Show last 10 WCY broadcasts
 === 0^SHOW/WCY <n>^Show last <n> WCY broadcasts
 Display the most recent WCY information that has been received by the system


@@ -1520,10 +1611,20 @@ you are on or else for the callsign that you asked for.
 
 Only the fields that are defined (in perl term) will be displayed.
 
 
 Only the fields that are defined (in perl term) will be displayed.
 

-=== 5^STAT/MSG <msgno>^Show the status of a message
+=== 1^STAT/MSG^Show the status of the message system
+=== 1^STAT/MSG <msgno>^Show the status of a message

 This command shows the internal status of a message and includes information
 such as to whom it has been forwarded, its size, origin etc etc.
 
 This command shows the internal status of a message and includes information
 such as to whom it has been forwarded, its size, origin etc etc.
 

+If no message number is given then the status of the message system is 
+displayed.
+
+=== 5^STAT/ROUTE_NODE <callsign>^Show the data in a Route::Node object
+=== 5^STAT/ROUTE_NODE all^Show list of all Route::Node objects
+
+=== 5^STAT/ROUTE_USER <callsign>^Show the data in a Route::User object
+=== 5^STAT/ROUTE_USER all^Show list of all Route::User objects
+

 === 5^STAT/USER [<callsign>]^Show the full status of a user
 Shows the full contents of a user record including all the secret flags
 and stuff.
 === 5^STAT/USER [<callsign>]^Show the full status of a user
 Shows the full contents of a user record including all the secret flags
 and stuff.