added MSG help
[spider.git] / cmd / Commands_en.hlp
index 368d57d5610063d7719435c5fd9c44d2af8685ff..83d33ef879a8f3a36a222bda630903e2c20efa9e 100644 (file)
@@ -34,6 +34,25 @@ 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>.
 
+=== 9^CATCH <node call> All|[<msgno> ...]^Mark a message as sent
+=== 9^UNCATCH <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
+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:-
+
+    catch GB7DJK all
+    catch GB7DJK 300 301 302 303
+       
+and to undo what you have just done:-
+
+       uncatch GB7DJK all
+       uncatch GB7DJK 300 301 302 303
+
+which will arrange for them to be forward candidates again.
+
 === 9^DEBUG^Set the cluster program into debug mode
 Executing this command will only have an effect if you are running the cluster
 in debug mode i.e.
@@ -44,14 +63,31 @@ 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 NEW^List your own new messages
-List the messages in the messages directory. 
+=== 0^DIRECTORY NEW^List all new messages
+=== 0^DIRECTORY TO <call>^List all messages to <call>
+=== 0^DIRECTORY FROM <call>^List all messages from <call>
+=== 0^DIRECTORY SUBJECT <string>^List all messages with <string> in subject
+=== 0^DIRECTORY <nn>^List last <nn> messages
+=== 0^DIRECTORY <from>-<to>^List messages <from> message <to> message 
+List the messages in the messages directory.
 
 If there is a 'p' one space after the message number then it is a 
-personal message.
+personal message. If there is a '-' between the message number and the
+'p' then this indicates that the message has been read.
+
+You can use shell escape characters such as '*' and '?' in the <call>
+fields.
+
+You can combine some of the various directory commands together eg:-
 
-If there is a - after the message number then this indicates that the
-message has been read.
+   DIR TO G1TLH 5
+or 
+   DIR SUBJECT IOTA 200-250
+
+You can abbreviate all the commands to one letter and use ak1a syntax:-
+
+   DIR/T G1* 10
+   DIR/S QSL 10-100 5
 
 === 5^DIRECTORY-^
 Sysops can see all users' messages.
@@ -119,6 +155,39 @@ unknown message 'xxxx' in lang 'en'
 Reload the /spider/data/prefix_data.pl file if you have changed it manually whilst
 the cluster is running. 
 
+=== 5^MERGE <node> [<no spots>/<no wwv>]^Ask for the latest spots and WWV 
+MERGE allows you to bring your spot and wwv database up to date. By default
+it will request the last 10 spots and 5 WWVs from the node you select. The 
+node must be connected locally.
+
+You can request any number of spots or wwv and although they will be appended
+to your databases they will not duplicate any that have recently been added 
+(the last 2 days for spots and last month for WWV data).
+
+=== 9^MSG <cmd> <msgno> [data ... ]^Alter various message parameters
+Alter message parameters like To, From, Subject, whether private or bulletin
+or return receipt (RR) is required or whether to keep this message from timing
+out.
+
+  MSG TO <msgno> <call>     - change TO callsign to <call>
+  MSG FRom <msgno> <call>   - change FROM callsign to <call>
+  MSG PRrivate <msgno>      - set private flag
+  MSG NOPRrivate <msgno>    - unset private flag
+  MSG RR <msgno>            - set RR flag
+  MSG NORR <msgno>          - unset RR flag
+  MSG KEep <msgno>          - set the keep flag (message won't be deleted ever)
+  MSG NOKEep <msgno>        - unset the keep flag
+  MSG SUbject <msgno> <new> - change the subject to <new>
+  MSG WAittime <msgno>      - remove any waitting time for this message
+  MSG QUeue                 - queue any outstanding bulletins
+  MSG QUeue 1               - queue any outstanding private messages
+
+You can look at the status of a message by using:-
+
+  STAT/MSG <msgno>      
+
+This will display more information on the message than DIR does.
+   
 === 8^PC <call> <text>^Send text (eg PC Protocol) to <call>
 Send some arbitrary text to a locally connected callsign. No processing is done on
 the text. This command allows you to send PC Protocol to unstick things if problems
@@ -136,17 +205,14 @@ cluster and be returned.
 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.
 
-=== 5^KILL-^
-As a sysop you can kill any message on the system.
+=== 5^KILL <from>-<to>^Remove a range of messages from the system
+=== 5^KILL FROM <call>^Remove all messages from a callsign
+=== 5^KILL TO <call>^Remove all messages to a callsign
+=== 5^KILL FULL <msgno> [<msgno]^Remove a message from the entire cluster
+Remove this message from the entire cluster system as well as your node.
 
-=== 5^MERGE <node> [<no spots>/<no wwv>]^Ask for the latest spots and WWV 
-MERGE allows you to bring your spot and wwv database up to date. By default
-it will request the last 10 spots and 5 WWVs from the node you select. The 
-node must be connected locally.
-
-You can request any number of spots or wwv and although they will be appended
-to your databases they will not duplicate any that have recently been added 
-(the last 2 days for spots and last month for WWV data).
+=== 5^KILL^
+As a sysop you can kill any message on the system.
 
 === 8^PC <call> <text>^Send arbitrary text to a connected callsign
 Send any text you like to the callsign requested. This is used mainly to send
@@ -246,7 +312,12 @@ You can potentially connect several nodes in this way.
 === 9^UNSET/ISOLATE^Stop Isolation of a node from the rest of the network
 Remove isolation from a node - SET/ISOLATE
 
+=== 0^SET/LANGUAGE <lang>^Set the language you want to use
+You can select the language that you want the cluster to use. Currently
+the languages available are en (english) and nl (dutch).
+
 === 0^SET/LOCATION <lat & long>^Set your latitude and longitude
+=== 9^SET/SYS_LOCATION <lat & long>^Set your cluster latitude and longitude
 In order to get accurate headings and such like you must tell the system
 what your latitude and longitude is. If you have not yet done a SET/QRA
 then this command will set your QRA locator for you. For example:-
@@ -269,7 +340,7 @@ of output from a command is more than this. The default is 20. Setting it
 explicitly to 0 will disable paging. 
   SET/PAGE 30
   SET/PAGE 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:-
@@ -283,7 +354,14 @@ to commands are as default:-
 If you are a sysop and you come in as a normal user on a remote connection
 your privilege will automatically be set to 0.
 
+=== 9^SET/PASSWORD <callsign> <string>^Set a users password
+The password for a user can only be set by a full sysop. The string
+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.
 === 0^SET/QRA <locator>^Set your QRA locator
+=== 9^SET/SYS_QRA <locator>^Set your cluster QRA locator
 Tell the system what your QRA (or Maidenhead) locator is. If you have not
 done a SET/LOCATION then your latitude and longitude will be set roughly
 correctly (assuming your locator is correct ;-). For example:-
@@ -299,6 +377,9 @@ Tell the system where you are. For example:-
 === 0^SET/WWV^Allow WWV messages to come out on your terminal
 === 0^UNSET/WWV^Stop WWV 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/DX^Interrogate the spot database
 If you just type SHOW/DX you will get the last so many spots
 (sysop configurable, but usually 10).
@@ -321,13 +402,29 @@ day <from>-<to> - <from> days <to> days ago
    
 info <text>     - any spots containing <text> in the info or remarks
    
-spotter <call>  - any spots spotted by <call>
+by <call>       - any spots spotted by <call> (spotter <call> is the 
+                  same).
+
+qsl             - this automatically looks for any qsl info on the call
+                  held in the spot database.
+
+iota [<iota>]   - If the iota island number is missing it will look for
+                  the string iota and anything which looks like an iota
+                  island number. If you specify then it will look for  
+                  that island.
+
+qra [<locator>] - this will look for the specific locator if you specify
+                  one or else anything that looks like a locator.
    
 e.g. 
    
    SH/DX 9m0
    SH/DX on 20m info iota
    SH/DX 9a on vhf day 30
+   SH/DX rf1p qsl
+   SH/DX iota 
+   SH/DX iota eu-064
+   SH/DX qra jn86
   
 === 0^SHOW/DXCC <prefix>^Interrogate the spot database by country
 This command takes the <prefix> (which can be a full or partial 
@@ -340,6 +437,20 @@ e.g.
    SH/DXCC G
    SH/DXCC W on 20m info iota
 
+=== 0^SHOW/FILES [<filearea> [<string>]]^List the contents of a filearea
+SHOW/FILES on its own will show you a list of the various fileareas
+available on the system. To see the contents of a particular file
+area type:-
+   SH/FILES <filearea>
+where <filearea> is the name of the filearea you want to see the 
+contents of.
+
+You can also use shell globbing characters like '*' and '?' in a
+string to see a selection of files in a filearea eg:-
+   SH/FILES bulletins arld*
+
+See also TYPE - to see the contents of a file.
+
 === 0^SHOW/PREFIX <callsign>^Interrogate the prefix database 
 This command takes the <callsign> (which can be a full or partial 
 callsign or a prefix), looks up which internal country number 
@@ -348,6 +459,10 @@ together with the internal country no, the CQ and ITU regions.
 
 See also SHOW/DXCC
 
+=== 0^SHOW/PROGRAM^Show the locations of all the included program modules
+Show the name and location where every program module was load from. This
+is useful for checking where you think you have loaded a .pm file from. 
+
 === 0^SHOW/WWV^Show last 10 WWV broadcasts
 === 0^SHOW/WWV <n>^Show last <n> WWV broadcasts
 Display the most recent WWV information that has been received by the system
@@ -367,6 +482,31 @@ and stuff.
 
 Only the fields that are defined (in perl term) will be displayed.
 
+=== 0^SYSOP^Regain your privileges if you login remotely
+The system automatically reduces your privilege level to that of a
+normal user if you login in remotely. This command allows you to
+regain your normal privilege level. It uses the normal system: five
+numbers are returned that are indexes into the character array that is
+your assigned password (see SET/PASSWORD). The indexes start from
+zero.
+
+You are expected to return a string which contains the characters
+required in the correct order. You may intersperse those characters
+with others to obscure your reply for any watchers. For example (and
+these values are for explanation :-):
+
+password = 012345678901234567890123456789
+ > sysop
+22 10 15 17 3
+you type:-
+aa2bbbb0ccc5ddd7xxx3n
+or 2 0 5 7 3
+or 20573
+
+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.
+
 === 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
@@ -381,6 +521,19 @@ 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.
 
+=== 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 
+enter:-
+   TYPE bulletins/arld051
+
+See also SHOW/FILES to see what fileareas are available and a 
+list of content.
+
+=== 0^WHO^Show who is physically connected
+This is a quick listing that shows which callsigns are connected and
+what sort of connection they have
+
 === 0^WX <text>^Send a weather message to local users
 === 0^WX FULL <text>^Send a weather message to all cluster users
 === 5^WX SYSOP <text>^Send a weather message to other clusters only