add 'in program' download cmd to replace wget
[spider.git] / cmd / Commands_en.hlp
index 3bef48cd754d7a1dadcffbe5f6d4ca681b35ad4c..6d37efb96f459627dbe3daa385f0cef11c925253 100644 (file)
@@ -616,7 +616,24 @@ or everything (except yourself) with
 
   DISC all
 
-=== 0^DX [BY <call>] <freq> <call> <remarks>^Send a DX spot
+=== 9^DOWNLOAD <url>^Download a file into local_data
+This command is a direct replacement for the unix 'wget -Qn' command
+that is used to download files like badip, spot data, user databases
+like usdb. It is designed to work either on the command line in a console
+or (more likely) in the crontab, like the example below:
+
+24 * * * * run_cmd('download http://www.dxspider.net/download/badip.torexit')
+24 * * * * run_cmd('download http://www.dxspider.net/download/badip.torrelay')
+24 * * * * run_cmd('download http://www.dxspider.net/download/badip.global')
+25 * * * * run_cmd('load/badip')
+
+If you do use the crontab then *please* use a random minute between 15-40
+and not all use minute 24.
+
+Windows users may well find this particularly useful.
+
+=== 0^DX <freq> <call> <remarks>^Send a DX spot
+=== 2^DX [BY <call>] [ip <ipaddress>] <freq> <call> <remarks>^Send a DX spot
 This is how you send a DX Spot to other users. You can, in fact, now
 enter the <freq> and the <call> either way round. 
 
@@ -995,6 +1012,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 +1145,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 +1651,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 
@@ -2179,12 +2239,16 @@ for more information.
 
 === 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 show each word with its associated perl regex.
+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
@@ -2771,6 +2835,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.