add more routing code together with associated commands

[spider.git] / cmd / Commands_en.hlp

diff --git a/cmd/Commands_en.hlp b/cmd/Commands_en.hlp
index dbfa1770083c46529e9c00a20539b605fedcc002..eaef20c9bb99fcd6ed413676efe3e1d1e65324b7 100644 (file)
--- a/cmd/Commands_en.hlp
+++ b/cmd/Commands_en.hlp
@@ -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
 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:-
 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:-


@@ -59,7 +59,7 @@ default for nodes and users eg:-
 Create an 'accept this spot' line for a filter. 
 
 An accept filter line means that if the spot matches this filter it is
 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:-
 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:-


@@ -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.
        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
 === 0^DIRECTORY^List messages 
 === 0^DIRECTORY ALL^List all messages
 === 0^DIRECTORY OWN^List your own messages


@@ -738,7 +739,7 @@ As a sysop you may read any message on the system
 Create an 'reject this announce' line for a filter. 
 
 A reject filter line means that if the announce matches this filter it is
 Create an 'reject this announce' line for a filter. 
 
 A 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
+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:-
 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:-


@@ -778,7 +779,7 @@ default for nodes and users eg:-
 Create a 'reject this spot' line for a filter. 
 
 A reject filter line means that if the spot matches this filter it is
 Create a 'reject this spot' line for a filter. 
 
 A 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
+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:-
 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:-


@@ -926,19 +927,20 @@ SP is an alias for SEND PRIVATE
 
 === 5^SET/ARCLUSTER <call> [<call>..]^Make the callsign an AR-Cluster node
 
 
 === 5^SET/ARCLUSTER <call> [<call>..]^Make the callsign an AR-Cluster node
 

-=== 8^SET/BADDX <call>..^Stop spots for this callsign being propagated
-=== 8^UNSET/BADDX <call>..^Allow spots for this callsign again
-Setting a callsign as a 'baddx' will prevent spots of this callsign 
-going any further. They will not be displayed and they will not be 
-sent onto other nodes.
+=== 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 call must be a full eg:-
+The word must be wriiten in full, no wild cards are allowed eg:-

 
 

-  set/baddx FORSALE VIDEO FR0G 
+  set/baddx FORSALE VIDEO FR0G

 
 

-  unset/badnode VIDEO
+To allow a word again, use the following command ...

 
 

-will allow spots to that callsign again.
+  unset/baddx VIDEO

 
 === 8^SET/BADNODE <call>..^Stop spots from this node being propagated
 === 8^UNSET/BADNODE <call>..^Allow spots from this node again
 
 === 8^SET/BADNODE <call>..^Stop spots from this node being propagated
 === 8^UNSET/BADNODE <call>..^Allow spots from this node again


@@ -965,26 +967,37 @@ 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.
 
 going any further. They will not be displayed and they will not be 
 sent onto other nodes.
 

-The call must be a full eg:-
+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.
 
 
   set/badspotter VE2STN 
 
 will stop anything from VE2STN. If you want SSIDs as well then you must
 enter them specifically.
 

-  unset/badnode VE2STN
+  unset/badspotter VE2STN

 
 will allow spots from him again.
 
 
 will allow spots from him again.
 

-Use with extreme care. This command may well be superceeded by FILTERing.
+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
 === 9^UNSET/DEBUG <name>^Remove a debug level from 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
 === 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
 
 === 0^SET/DX^Allow DX messages to come out on your terminal
 === 0^UNSET/DX^Stop DX messages coming out on your terminal


@@ -1183,6 +1196,21 @@ for more information.
 Display all the bad spotter's callsigns in the system, see SET/BADSPOTTER
 for more information.
 
 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.
 === 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.


@@ -1192,6 +1220,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.
 
 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).
 === 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).


@@ -1276,6 +1306,11 @@ all the categories will be listed.
 
 === 9^SHOW/LOCKOUT^Show the list of locked out or excluded callsigns
 
 
 === 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
 === 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


@@ -1487,10 +1522,18 @@ 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_USER <callsign>^Show the data in a Route::User object
+

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