added some help

[spider.git] / cmd / Commands_en.hlp

diff --git a/cmd/Commands_en.hlp b/cmd/Commands_en.hlp
index 489308c3c3ef1f3679327ca90244442dd82e6e3c..bb0420865fb23144d50db50e9490116238e83824 100644 (file)
--- a/cmd/Commands_en.hlp
+++ b/cmd/Commands_en.hlp
@@ -32,8 +32,8 @@ 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>.
 
 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^CATCH <node call> All|[<msgno> ...]^Mark a message as sent
-=== 9^UNCATCH <node call> All|[msgno> ...]^Unmark a message as sent
+=== 5^CATCHUP <node call> All|[<msgno> ...]^Mark a message as sent
+=== 5^UNCATCHUP <node call> All|[msgno> ...]^Unmark a message as sent

 When you send messages the fact that you have forwarded it to another node 
 is remembered so that it isn't sent again. When you have a new partner
 node and you add their callsign to your /spider/msg/forward.pl file, all
 When you send messages the fact that you have forwarded it to another node 
 is remembered so that it isn't sent again. When you have a new partner
 node and you add their callsign to your /spider/msg/forward.pl file, all


@@ -41,16 +41,18 @@ outstanding non-private messages will be forwarded to them. This may well
 be ALL the non-private messages. You can prevent this by using these 
 commmands:-
 
 be ALL the non-private messages. You can prevent this by using these 
 commmands:-
 

-  catch GB7DJK all
-  catch GB7DJK 300 301 302 303
+  catchup GB7DJK all
+  catchup GB7DJK 300 301 302 303 500-510

        
 and to undo what you have just done:-
   
        
 and to undo what you have just done:-
   

-  uncatch GB7DJK all
-  uncatch GB7DJK 300 301 302 303
+  uncatchup GB7DJK all
+  uncatchup GB7DJK 300 301 302 303 500-510

 
 which will arrange for them to be forward candidates again.
 
 
 which will arrange for them to be forward candidates again.
 

+Order is not important.
+

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


@@ -229,6 +231,16 @@ access. For example:-
 
   EXPORT 2345 /tmp/a
 
 
   EXPORT 2345 /tmp/a
 

+=== 9^EXPORT_USERS [<filename>]^Export the users database to ascii
+Export the users database to a file in ascii format. If no filename
+is given then it will export the file to /spider/data/user_asc.
+
+If the file already exists it will be renamed to <filename>.o. In fact
+up to 5 generations of the file can be kept each one with an extra 'o' on the
+suffix. 
+
+BE WARNED: this will write to any file you have write access to. No check is
+made on the filename (if any) that you specify.

 
 === 1^FORWARD/OPERNAME <call>^Send out information on this <call> to all clusters
 This command sends out any information held in the user file which can 
 
 === 1^FORWARD/OPERNAME <call>^Send out information on this <call> to all clusters
 This command sends out any information held in the user file which can 


@@ -282,6 +294,25 @@ 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. 
 
 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 
+expressions which are searched for in the fields targetted of each message. 
+If any of them match then that message is immediately deleted on receipt. 
+
+=== 9^LOAD/BADWORDS^Reload the bad words table
+Reload the /spider/data/badwords file if you have changed it manually whilst
+the cluster is running. This file contains a list of words which, if found
+on certain text portions of PC protocol, will cause those protocol frames
+to be rejected. It will all put out a message if any of these words are
+used on the announce, dx and talk commands. The words can be one or 
+more on a line, lines starting with '#' are ignored.
+

 === 9^LOAD/CMD_CACHE^Reload the automatic command cache
 Normally, if you change a command file in the cmd or local_cmd tree it
 will automatially be picked up by the cluster program. Sometimes it
 === 9^LOAD/CMD_CACHE^Reload the automatic command cache
 Normally, if you change a command file in the cmd or local_cmd tree it
 will automatially be picked up by the cluster program. Sometimes it


@@ -290,6 +321,10 @@ delete a command in the local_cmd tree and want to use the normal one
 again. Execute this command to reset everything back to the state it
 was just after a cluster restart.
 
 again. Execute this command to reset everything back to the state it
 was just after a cluster restart.
 

+=== 9^LOAD/FORWARD^Reload the msg forwarding routing table
+Reload the /spider/msg/forward.pl file if you have changed it
+manually whilst the cluster is running.
+

 === 9^LOAD/MESSAGES^Reload the system messages file
 If you change the /spider/perl/Messages file (usually whilst
 fiddling/writing new commands) you can have them take effect during a
 === 9^LOAD/MESSAGES^Reload the system messages file
 If you change the /spider/perl/Messages file (usually whilst
 fiddling/writing new commands) you can have them take effect during a


@@ -436,15 +471,29 @@ SP is an alias for SEND PRIVATE
 === 0^SET/ANNOUNCE^Allow announce messages to come out on your terminal
 === 0^UNSET/ANNOUNCE^Stop announce messages coming out on your terminal
 
 === 0^SET/ANNOUNCE^Allow announce messages to come out on your terminal
 === 0^UNSET/ANNOUNCE^Stop announce messages coming out on your terminal
 

+=== 5^SET/ARCLUSTER <call> [<call>..]^Make the callsign an AR-Cluster node
+

 === 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/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
 
 === 0^SET/DX^Allow DX messages to come out on your terminal
 === 0^UNSET/DX^Stop DX messages coming out on your terminal
 
 === 9^SET/DEBUG <name>^Add a debug level to the debug set
 === 9^UNSET/DEBUG <name>^Remove a debug level from the debug set
 
 === 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/DXGRID^Allow Grid Squares on the end of DX announcements
+=== 0^UNSET/DXGRID^Stop Grid Squares on the end of DX announcements
+A standard feature which is enabled in version 1.43 and above is 
+that if the spotter's grid square is known it is output on the end
+of a DX announcement (there is just enough room). Some user programs
+cannot cope with this. You can use this command to reset (or set)
+this feature.
+
+=== 5^SET/DXNET <call> [<call>..]^Make the callsign an DXNet node
+

 === 0^SET/ECHO^Make the cluster echo your input
 === 0^UNSET/ECHO^Stop the cluster echoing your input
 If you are connected via a telnet session, different implimentations
 === 0^SET/ECHO^Make the cluster echo your input
 === 0^UNSET/ECHO^Stop the cluster echoing your input
 If you are connected via a telnet session, different implimentations


@@ -496,11 +545,11 @@ then this command will set your QRA locator for you. For example:-
 Tell the system what your name is eg:-
   SET/NAME Dirk
 
 Tell the system what your name is eg:-
   SET/NAME Dirk
 

-=== 9^SET/NODE <call> [<call>..]^Make the callsign an AK1A cluster
+=== 5^SET/NODE <call> [<call>..]^Make the callsign an AK1A cluster

 Tell the system that the call(s) are to be treated as AK1A cluster and
 fed PC Protocol rather normal user commands.
 
 Tell the system that the call(s) are to be treated as AK1A cluster and
 fed PC Protocol rather normal user commands.
 

-=== 9^SET/OBSCOUNT <count> <nodecall>^Set the 'pump-up' obscelence counter 
+=== 8^SET/OBSCOUNT <count> <nodecall>^Set the 'pump-up' obscelence counter 

 From 1.35 onwards neighbouring nodes are pinged at regular intervals (see
 SET/PINGINTERVAL), usually 300 seconds or 5 minutes. There is a 'pump-up'
 counter which is decremented on every outgoing ping and then reset to
 From 1.35 onwards neighbouring nodes are pinged at regular intervals (see
 SET/PINGINTERVAL), usually 300 seconds or 5 minutes. There is a 'pump-up'
 counter which is decremented on every outgoing ping and then reset to


@@ -557,7 +606,7 @@ can contain any characters but any spaces are removed (you can type in
 spaces - but they won't appear in the password). You can see the
 result with STAT/USER.
 
 spaces - but they won't appear in the password). You can see the
 result with STAT/USER.
 

-=== 9^SET/SPIDER <call> [<call>..]^Make the callsign an DXSpider node
+=== 5^SET/SPIDER <call> [<call>..]^Make the callsign an DXSpider node

 Tell the system that the call(s) are to be treated as DXSpider node and
 fed new style DX Protocol rather normal user commands.
 
 Tell the system that the call(s) are to be treated as DXSpider node and
 fed new style DX Protocol rather normal user commands.
 


@@ -584,6 +633,10 @@ 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
 
 === 0^SET/WX^Allow WX messages to come out on your terminal
 === 0^UNSET/WX^Stop WX messages coming out on your terminal
 

+=== 0^SHOW/CALL <callsign>^Show any callbook details on a callsign
+This command queries an international callbook server on the internet
+and returns any information available for that callsign. 
+

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


@@ -846,6 +899,16 @@ Display the most recent WWV information that has been received by the system
 === 5^SHUTDOWN^Shutdown the cluster
 Shutdown the cluster and disconnect all the users 
 
 === 5^SHUTDOWN^Shutdown the cluster
 Shutdown the cluster and disconnect all the users 
 

+=== 9^SPOOF <call> <command>^Do a command as though you are another user
+This command is provided so that sysops can set a user's parameters without
+me having to write a special 'sysop' version for every user command. It
+allows you to pretend that you are doing the command as the user you specify.
+
+eg:-
+
+   SPOOF G1TLH set/name Dirk
+   SPOOF G1TLH set/qra JO02LQ
+

 === 5^STAT/DB <dbname>^Show the status of a database
 Show the internal status of a database descriptor.
 
 === 5^STAT/DB <dbname>^Show the status of a database
 Show the internal status of a database descriptor.
 


@@ -893,8 +956,8 @@ They will all match. If there is no password you will still be offered
 numbers but nothing will happen when you input a string. Any match is
 case sensitive.
 
 numbers but nothing will happen when you input a string. Any match is
 case sensitive.
 

-=== 0^TALK <call> <text>^Send a text message to another station
-=== 0^TALK <call> > <node> <text>^Send a text message to another station via a node
+=== 0^TALK <call> [<text>]^Send a text message to another station
+=== 0^TALK <call> > <node> [<text>]^Send a text message to another station via a node

 Send a short message to any other station that is visible on the cluster
 system. You can send it to anyone you can see with a SHOW/CONFIGURATION 
 command, they don't have to be connected locally.
 Send a short message to any other station that is visible on the cluster
 system. You can send it to anyone you can see with a SHOW/CONFIGURATION 
 command, they don't have to be connected locally.


@@ -907,6 +970,25 @@ If you know that G3JNB is likely to be present on GB7TLH, but you can only
 see GB7TLH in the SH/C list but with no users, then you would use the
 second form of the talk message.
 
 see GB7TLH in the SH/C list but with no users, then you would use the
 second form of the talk message.
 

+If you want to have a ragchew with someone you can leave the text message
+out and the system will go into 'Talk' mode. What this means is that a
+short message is sent to the recipient telling them that you are in a
+'Talking' frame of mind and then you just type - everything you send will
+go to the station that you asked for. 
+
+All the usual announcements, spots and so on will still come out on your
+terminal.
+
+If you want to do something (such as send a spot) you preceed the normal 
+command with a '/' character, eg:-
+
+   /DX 14001 G1TLH What's a B class licensee doing on 20m CW?
+   /HELP talk
+
+To leave talk mode type:
+   
+   /EX
+

 === 0^TYPE <filearea>/<name>^Look at the contents of a file in one of the fileareas
 Type out the contents of a file in a filearea. So, for example, in 
 filearea 'bulletins' you want to look at file 'arld051' you would 
 === 0^TYPE <filearea>/<name>^Look at the contents of a file in one of the fileareas
 Type out the contents of a file in a filearea. So, for example, in 
 filearea 'bulletins' you want to look at file 'arld051' you would