add various stats commands
[spider.git] / cmd / Commands_en.hlp
index 506c89882a23e91ce79eecd3d96d901774817aff..3098cc296418a545e0c0208b01cf4f8e90a44fa3 100644 (file)
@@ -15,7 +15,7 @@
 Create an 'accept this announce' line for a filter. 
 
 An accept filter line means that if the announce matches this filter it is
-passed onto the user. See HELP FILTERS for more info. Please read this
+passed onto the user. 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:-
@@ -55,11 +55,39 @@ default for nodes and users eg:-
   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. 
 
 An accept filter line means that if the spot matches this filter it is
-passed onto the user. See HELP FILTERS for more info. Please read this
+passed onto the user. 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:-
@@ -95,6 +123,7 @@ You can use the tag 'all' to accept everything, eg:
 
 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:-
@@ -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>.
 
+=== 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.
@@ -341,6 +374,7 @@ in debug mode i.e.
        perl -d cluster.pl
 
 It will interrupt the cluster just after the debug command has finished.
+
 === 0^DIRECTORY^List messages 
 === 0^DIRECTORY ALL^List all messages
 === 0^DIRECTORY OWN^List your own messages
@@ -547,6 +581,14 @@ thru everything else on HF.
 
 The next filter line lets through just VHF/UHF spots from EU.
 
+=== 8^FORWARD/LATLONG <node_call>^Send latitude and longitude information to another cluster
+This command sends all the latitude and longitude information that your
+cluster is holding against callsigns.  One advantage of recieving this
+information is that more locator information is held by you.  This
+means that more locators are given on the DX line assuming you have
+SET/DXGRID enabled.  This could be a LOT of information though, so
+it is not recommended on slow links.
+
 === 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
@@ -599,11 +641,6 @@ running in order for the changes to take effect.
 Reload the /spider/data/bands.pl file if you have changed it manually whilst
 the cluster is running. 
 
-=== 9^LOAD/BADDX^Reload the bad DX table
-Reload the /spider/data/baddx.pl file if you have changed it manually whilst
-the cluster is running. This table contains the DX Calls that, if spotted, 
-will not be passed on. FR0G and TEST are classic examples.
-
 === 9^LOAD/BADMSG^Reload the bad msg table
 Reload the /spider/msg/badmsg.pl file if you have changed it manually whilst
 the cluster is running. This table contains a number of perl regular 
@@ -687,11 +724,6 @@ etc). eg:-
 or 
    pc G1TLH Try doing that properly!!!
 
-=== 1^PING <node>^Send a ping command to another cluster
-This command is used to estimate the quality of the link to another cluster. 
-The time returned is the length of time taken for a PC51 to go to another 
-cluster and be returned.
-
 === 0^KILL <msgno> [<msgno> ...]^Remove or erase a message from the system
 You can get rid of any message to or originating from your callsign using 
 this command. You can remove more than one message at a time.
@@ -712,10 +744,11 @@ PC protocol to connected nodes either for testing or to unstick things.
 You can also use in the same way as a talk command to a connected user but
 without any processing, added of "from <blah> to <blah" or whatever.
  
-=== 1^PING <node call>^Find out the delays an a circuit to another node
-This command will enable sysops to determine the speed of an inter-cluster
-node. 
-
+=== 1^PING <node call>^Check the link quality between nodes
+This command allows you to send a frame to another cluster node on
+the network and get a return frame.  The time it takes to do this
+is a good indication of the quality of the link.  The actual time
+it takes is output to the console in seconds.
 Any visible cluster node can be PINGed.
 
 === 1^RCMD <node call> <cmd>^Send a command to another DX Cluster
@@ -735,11 +768,11 @@ message either sent by or sent to your callsign.
 === 5^READ-^
 As a sysop you may read any message on the system
 
-=== 0^REJECT/ANNOUNCE [0-9] <pattern>^Set an 'reject' filter line for announce
+=== 0^REJECT/ANNOUNCE [0-9] <pattern>^Set a 'reject' filter line for announce
 Create an 'reject this announce' line for a filter. 
 
-An reject filter line means that if the announce matches this filter it is
-passed onto the user. See HELP FILTERS for more info. Please read this
+A reject filter line means that if the announce matches this filter it is
+passed onto the user. 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:-
@@ -775,11 +808,11 @@ default for nodes and users eg:-
   reject/ann input node_default by G,M,2
   reject/ann user_default by G,M,2
 
-=== 0^REJECT/SPOTS [0-9] <pattern>^Set an 'reject' filter line for spots
-Create an 'reject this spot' line for a filter. 
+=== 0^REJECT/SPOTS [0-9] <pattern>^Set a 'reject' filter line for spots
+Create a 'reject this spot' line for a filter. 
 
-An reject filter line means that if the spot matches this filter it is
-dumped (not passed on). See HELP FILTERS for more info. Please read this
+A reject filter line means that if the spot matches this filter it is
+dumped (not passed on). 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:-
@@ -815,6 +848,32 @@ You can use the tag 'all' to reject everything eg:
 
 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:-
@@ -825,7 +884,7 @@ 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
+=== 0^REJECT/WCY [0-9] <pattern>^set a '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:-
 
@@ -852,7 +911,7 @@ default for nodes and users eg:-
 
   reject/wcy gb7djk all
 
-=== 0^REJECT/WWV [0-9] <pattern>^set an 'reject' WWV filter
+=== 0^REJECT/WWV [0-9] <pattern>^set a '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:-
 
@@ -927,17 +986,33 @@ 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
+=== 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.
+
+The word must be wriiten in full, no wild cards are allowed eg:-
+
+  set/baddx FORSALE VIDEO FR0G
+
+To allow a word again, use the following command ...
+
+  unset/baddx VIDEO
+
+=== 8^SET/BADNODE <call>..^Stop spots from this node being propagated
+=== 8^UNSET/BADNODE <call>..^Allow spots from this node 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:-
+The call must be a full eg:-
 
   set/badnode K1TTT 
 
-will stop anything from K1TTT (including any SSID's)
+will stop anything from K1TTT. If you want SSIDs as well then you must
+enter them specifically.
 
   unset/badnode K1TTT
 
@@ -945,13 +1020,43 @@ will allow spots from him again.
 
 Use with extreme care. This command may well be superceeded by FILTERing.
 
+=== 8^SET/BADSPOTTER <call>..^Stop spots from this callsign being propagated
+=== 8^UNSET/BADSPOTTER <call>..^Allow spots from this callsign again
+Setting a callsign as a 'badspotter' will prevent spots from this callsign 
+going any further. They will not be displayed and they will not be 
+sent onto other nodes.
+
+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.
+
+  unset/badspotter VE2STN
+
+will allow spots from him again.
+
+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
 
+=== 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
 === 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
+
+You can show what levels you are logging with SHOW/DEBUG
 
 === 0^SET/DX^Allow DX messages to come out on your terminal
 === 0^UNSET/DX^Stop DX messages coming out on your terminal
@@ -1049,6 +1154,10 @@ If a ping is heard then the obscount is reset to the full value. Using
 default values, if a node has not responded to a ping within 15 minutes,
 it is disconnected.
 
+You can set this parameter between 1 and 9.
+
+It is STRONGLY recommended that you don't change the default.
+
 === 0^SET/PAGE <lines per page>^Set the lines per page
 Tell the system how many lines you wish on a page when the number of line
 of output from a command is more than this. The default is 20. Setting it
@@ -1065,13 +1174,29 @@ affect routing decisions. The default interval is 300 secs or 5 minutes.
 
 You can use this command to set a different interval. Please don't. 
 
-But if you do the value you enter is treated as minutes up 60 and seconds
+But if you do the value you enter is treated as minutes up 30 and seconds
 for numbers greater than that.
 
 This is used also to help determine when a link is down at the far end
 (as certain cluster software doesn't always notice), see SET/OBSCOUNT
 for more information.
 
+If you must change it (and it may be useful for internet connected nodes
+on dynamic IP addresses that go away after a set time of usage) the time
+can be specified as:-
+
+  5      which if less than 30 is converted to minutes otherwise is 
+         taken as the no of seconds between pings. 
+  120s   120 seconds
+  5m     5 minutes
+  1h     1 hour
+
+Please be aware that this causes traffic to occur on the link, setting 
+this value too low may annoy your neighbours beyond the point of 
+endurance!
+
+You can switch this off by setting it to 0.
+
 === 9^SET/PRIVILEGE <n> <call> [<call..]^Set privilege level on a call
 Set the privilege level on a callsign. The privilege levels that pertain
 to commands are as default:-
@@ -1085,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.
 
+=== 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
@@ -1118,10 +1249,33 @@ 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
 
-=== 6^SHOW/BADNODE^Show all the bad nodes in the system
+=== 1^SHOW/BADDX^Show all the bad dx calls in the system
+Display all the bad dx callsigns in the system, see SET/BADDX
+for more information.
+
+=== 1^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.
 
+=== 1^SHOW/BADSPOTTER^Show all the bad spotters in the system
+Display all the bad spotter's callsigns in the system, see SET/BADSPOTTER
+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.
+
+This command is normally abbreviated to: sh/c
+
+BE WARNED: the list that is returned can be VERY long
+
+=== 0^SHOW/CONFIGURATION/NODE^Show all the nodes connected locally
+Show all the nodes connected to this node.
+
+=== 1^SHOW/CONNECT^Show all the active connections
+This command shows information on all the active connections known to
+the node. This command gives slightly more information than WHO.
+
 === 0^SHOW/DATE [<prefix>|<callsign>]^Show the local time 
 This is very nearly the same as SHOW/TIME, the only difference the format
 of the date string if no arguments are given.
@@ -1131,6 +1285,8 @@ 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.
 
+=== 9^SHOW/DEBUG^Show what levels of debug information you are logging
+
 === 0^SHOW/DX^Interrogate the spot database
 If you just type SHOW/DX you will get the last so many spots
 (sysop configurable, but usually 10).
@@ -1188,6 +1344,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
@@ -1206,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.
 
+=== 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 
@@ -1215,6 +1380,11 @@ all the categories will be listed.
 
 === 9^SHOW/LOCKOUT^Show the list of locked out or excluded callsigns
 
+=== 8^SHOW/LOG [<callsign>]^Show excerpts from the system log
+This command outputs a short section of the system log.  On its own
+it will output a general logfile.  With the optional callsign it will
+show output from the log associated with that callsign.
+
 === 0^SHOW/MOON [<prefix>|<callsign>]^Show Moon rise and set times
 Show the Moon rise and set times for a (list of) prefixes or callsigns, 
 together with the azimuth and elevation of the sun currently at those
@@ -1343,6 +1513,12 @@ 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/ROUTE <callsign> ...^Show the route to the callsign
+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
+
 === 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.
@@ -1364,6 +1540,15 @@ So for example:-
 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
@@ -1387,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.
 
+=== 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
@@ -1420,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.
 
-=== 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.
 
+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.