Add the first draft of the usermanual and minor changes to adminmanual
[spider.git] / cmd / Commands_en.hlp
index 6968699a39a5557aad1d28763c41ba11cbf6bfbe..8c0b9543e0f7efbe690a00ca6afe23bfba7d9e49 100644 (file)
@@ -341,6 +341,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
@@ -607,11 +608,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 
@@ -695,11 +691,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.
@@ -720,10 +711,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
@@ -935,17 +927,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
 
@@ -953,6 +961,25 @@ 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
 
@@ -1057,6 +1084,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
@@ -1073,13 +1104,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:-
@@ -1126,10 +1173,18 @@ 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/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.
@@ -1223,6 +1278,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
@@ -1351,6 +1411,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.