add user level ping as link check command
[spider.git] / cmd / Commands_en.hlp
index ac67b14f81f6b093482e770a66d19416f354e2c5..63cef603878c022925d56a0c03cd5ca73cea1d10 100644 (file)
@@ -995,6 +995,21 @@ 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. 
 
+=== 6^LOAD/BADIP^Reload the bad IP address table
+Reload the badip address file(s) if you have changed any of them  manually
+whilst the cluster is running.
+
+You can edit the badip.* files manually in local_data or (for instance)
+obtain some bad IP addresses from the web to replace badip.base for TOR
+IP addresses (this filename may change).
+
+There is (currently) no UNSET/BADIP command so you will need to edit
+the badip.local file to remove IP addresses.
+
+After modification, you can reload the database with:
+
+  LOAD/BADIP
+
 === 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 
@@ -1113,6 +1128,27 @@ 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.
  
+=== 0^PING [argument]^User level link check command
+At the user level, this command allows the user to check that they
+are still connected to a functioning node. If the command is
+issued with no arguments it will return string 'PONG 123' where
+'123' is a node global counter starting at 1. This number cannot
+be relied to run consecutively as it is shared by all users.
+
+If an argument is supplied then the return is 'PONG ARGUMENT'. So it
+you are a client program and you need a counter or some other unique
+string to satisfy yourself that you are not being spoofed, then you
+will need to supply the argument and check that reply is what you
+expect:
+
+ping 23 or ping xyzzy
+
+will return
+
+PONG 23 or PONG XYZZY
+
+respectively.
+
 === 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
@@ -1598,6 +1634,13 @@ To allow a word again, use the following command ...
 
   unset/baddx VIDEO
 
+=== 6^SET/BADIP <ip address>..^Stop logins and spots with this IP address
+This command will prevent logins to this node from this IP address.
+It will also drop spots (PC61) from this address thus preventing them
+from being propagated.
+
+  set/badip 217.61.58.23
+
 === 6^SET/BADNODE <call>..^Stop spots from this node being propagated
 === 6^UNSET/BADNODE <call>..^Allow spots from this node again
 Setting a callsign as a 'badnode' will prevent spots from that node 
@@ -1641,22 +1684,43 @@ Use with extreme care. This command may well be superceded by FILTERing.
 This command will also stop TALK and ANNOUNCE/FULL from any user marked
 as a BADSPOTTER.
 
-=== 6^SET/BADWORD <word>..^Stop things with this word being propagated
-=== 6^UNSET/BADWORD <word>..^Propagate things with this word again
+=== 6^SET/BADWORD <word>..^Stop things like this word being propagated
 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:-
+This has changed its meaning from the master release. All words entered
+are reduced to the minimum regex that will match words starting like
+this one:
+
+  set/badword annihilate
 
-  set/badword annihilate annihilated annihilation 
+will stop anything that starts with these words in the text 
+like this:
 
-will stop anything with these words in the text.
+  annihilate annihilated
 
-  unset/badword annihilated
+but it will also stop things like this:
 
-will allow text with this word again.
+  anihilate annni11ihhh ii lllattt eee
+
+A few common 'leet' substitutions are automatically matched:
+
+  b0ll0cks bo0lll0ccckks fr1iigging
+
+and so on
+
+It will not stop some things like:
+
+  The base word FRIG will stop 'friiigging' but not 'friiig ging'
+
+=== 6^UNSET/BADWORD <word>..^Propagate things like this word again
+This is the opposite of set/badword <word>
+
+  unset/badword fred
+  
+will allow text with this word again (if it has been set as a bad word.
 
 === 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
@@ -2156,10 +2220,19 @@ 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
+=== 6^SHOW/BADWORD^Show all the bad words in the system
+=== 6^SHOW/BADWORD full^Show all badwords with their Regex
+=== 6^SHOW/BADWORD <word> ...^Show all badwords with their Regex
 Display all the bad words in the system, see SET/BADWORD
 for more information.
 
+The first form shows all the base words that are stored in a simple list.
+
+The second form list all words with their associated perl regex.
+
+The third form shows just the regexes for the words asked for. If no
+answer for a word is given then it is not defined.
+
 === 0^SHOW/BANDS [band|region names]^Show the list of bands and regions
 Display the bands and regions (collections of bands) known to
 the system. If you supply band or region names to SHOW/BANDS,
@@ -2745,6 +2818,18 @@ So for example:-
  SH/SAT AO-10 
  SH/SAT FENGYUN1 12 2
 
+=== 1^SHOW/SPOTSTATS^Show the current Spot statistics
+View the current unique spot sentences seen since the last restart.
+
+It shows the number of PC11 and PC61 sentences and the percentage
+of PC11s received of the total of both. It also shows the number
+of PC11s that have been promoted to PC61 before being passed on
+plus a total percentage of incoming PC11 that have been promoted.
+
+A PC11 can be promoted to PC61 by a stored IP address in the routing
+table or it can be promoted by being delayed to a short for any
+passing PC61 from another node.
 === 6^SHOW/STARTUP <call>^View a user startup script
 === 0^SHOW/STARTUP^View your own startup script
 View the contents of a startup script created with SET/STARTUP.