add the save and echo commands
[spider.git] / cmd / Commands_en.hlp
index 6043c6a42dce548d9294613f5f5ef5d21adfedd0..5d6dfde5d9abc87e7188f3dad2e43ba6bea62837 100644 (file)
@@ -497,6 +497,39 @@ You can credit someone else by saying:-
 The <freq> is compared against the available bands set up in the 
 cluster.  See SHOW/BANDS for more information.
 
+=== 0^ECHO <line>^Echo the line to the output
+This command is useful in scripts and so forth for printing the
+line that you give to the command to the output. You can use this
+in user_default scripts and the SAVE command for titling and so forth
+
+The script will interpret certain standard "escape" sequences as follows:-
+
+  \t - becomes a TAB character (0x09 in ascii)
+  \a - becomes a BEEP character (0x07 in ascii)
+  \n - prints a new line
+
+So the following example:-
+
+  echo GB7DJK is a dxcluster
+
+produces:-
+
+  GB7DJK is a dxcluster
+
+on the output. You don't need a \n on the end of the line you want to send.
+
+A more complex example:-
+
+  echo GB7DJK\n\tg1tlh\tDirk\n\tg3xvf\tRichard
+
+produces:-
+
+  GB7DJK
+          g1tlh   Dirk
+          g3xvf   Richard
+
+on the output.
+                                      
 === 9^EXPORT <msgno> <filename>^Export a message to a file
 Export a message to a file. This command can only be executed on a local
 console with a fully privileged user. The file produced will be in a form
@@ -766,6 +799,20 @@ was just after a cluster restart.
 Reload the /spider/msg/forward.pl file if you have changed it
 manually whilst the cluster is running.
 
+=== 5^LOAD/KEPS^Load new keps data
+=== 5^LOAD/KEPS [nn]^Load new keps data from message
+If there is no message number then reload the current Keps data from
+the Keps.pm data file. You create this file by running 
+
+ /spider/perl/convkeps.pl <filename>
+
+on a file containing NASA 2 line keps as a message issued by AMSAT. 
+
+If there is a message number, then it will take the message, run
+convkeps.pl on it and then load the data, all in one step.
+
+These messages are sent to ALL by GB7DJK (and others) from time to time. 
+
 === 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
@@ -1054,6 +1101,37 @@ You can also use all the extra qualifiers such as RR, PRIVATE,
 NOPRIVATE, B that you can use with the SEND command (see SEND
 for further details)
 
+=== 9^SAVE [-d -t -a] <filename> "<cmd>" [...]^Save command output to a file
+This sysop only cammand allows you to save the output of one or more
+commands to a file. For example:-
+
+  save /spider/packclus/dxstats show/dxstat
+
+will save the output of the normal command "show/dxstat" to the file
+"dxstats" in the files area.
+
+You can have some extra flags to the save which will either 
+date stamp or time stamp or both the filename so:-
+
+  save -d /tmp/a <cmd> creates /tmp/a_6-Jan-2002
+  save -t /tmp/a <cmd> creates /tmp/a_2301Z
+  save -d -t /tmp/a <cmd> creates /tmp/a_6-Jan-2002_2301Z
+
+The -a flag means append to the file instead of overwriting it.
+
+You can have more than one command on the line, to do this you MUST
+enclose each command in double quotes (") eg:-
+
+  save /tmp/a "sh/hfstats" "blank +" "sh/vhfstats"
+
+or
+
+  save /tmp/a "sh/hfstats","blank +","sh/vhfstats"
+
+You can only write into places that the cluster has permission for (which
+is that of the "sysop" user [which had BETTER NOT BE "root"]), you will 
+need to create any directories you want to put stuff in beforehand as well.
 === 0^SEND <call> [<call> ...]^Send a message to one or more callsigns
 === 0^SEND RR <call>^Send a message and ask for a read receipt
 === 0^SEND COPY <msgno> <call>^Send a copy of a  message to someone
@@ -1370,16 +1448,6 @@ use. If you want to get your normal privilege back you will need to
 either logout and login again (if you are on a console) or use the
 SYSOP command.
 
-=== 0^SET/PASSWORD^Set your own password
-This command only works for a 'telnet' user (currently). It will
-only work if you have a password already set. This initial password
-can only be set by the sysop.
-
-When you execute this command it will ask you for your old password,
-then ask you to type in your new password twice (to make sure you
-get it right). You may or may not see the data echoed on the screen
-as you type, depending on the type of telnet client you have.
-
 === 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. 
@@ -1397,10 +1465,32 @@ is set or the:
 command is executed in the startup script, then a password prompt is
 given after the normal 'login: ' prompt.  
 
+=== 0^SET/PASSWORD^Set your own password
+This command only works for a 'telnet' user (currently). It will
+only work if you have a password already set. This initial password
+can only be set by the sysop.
+
+When you execute this command it will ask you for your old password,
+then ask you to type in your new password twice (to make sure you
+get it right). You may or may not see the data echoed on the screen
+as you type, depending on the type of telnet client you have.
+
 === 9^UNSET/PASSWORD <call> ...^Delete (remove) a user's password
 This command allows the sysop to completely delete and remove a 
 password for a user. 
 
+=== 0^SET/PROMPT <string>^Set your prompt to <string>
+=== 0^UNSET/PROMPT^Set your prompt back to default
+This command will set your user prompt to exactly the string that you 
+say. The point of this command to enable a user to interface to programs
+that are looking for a specific prompt (or else you just want a different
+fixed prompt).
+
+  SET/PROMPT clx >
+
+UNSET/PROMPT will undo the SET/PROMPT command and set you prompt back to
+normal.
+
 === 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.
@@ -1496,9 +1586,12 @@ any order to the basic SHOW/DX command, they are:-
    
 on <band>       - eg 160m 20m 2m 23cm 6mm
 on <region>     - eg hf vhf uhf shf      (see SHOW/BANDS)
+on <from>/<to>  - eg 1000/4000 14000-30000  (in Khz)
+   <from>-<to>
    
 <number>        - the number of spots you want
 <from>-<to>     - <from> spot no <to> spot no in the selected list
+<from>/<to>
    
 <prefix>        - for a spotted callsign beginning with <prefix>
 *<suffix>       - for a spotted callsign ending in <suffix>
@@ -1506,7 +1599,8 @@ on <region>     - eg hf vhf uhf shf      (see SHOW/BANDS)
    
 day <number>    - starting <number> days ago
 day <from>-<to> - <from> days <to> days ago
-   
+    <from>/<to>   
+
 info <text>     - any spots containing <text> in the info or remarks
    
 by <call>       - any spots spotted by <call> (spotter <call> is the 
@@ -1522,6 +1616,13 @@ iota [<iota>]   - If the iota island number is missing it will look for
 
 qra [<locator>] - this will look for the specific locator if you specify
                   one or else anything that looks like a locator.
+
+dxcc            - treat the prefix as a 'country' and look for spots
+                  from that country regardless of actual prefix.
+                  eg dxcc oq2 
+                  
+                  You can also use this with the 'by' keyword so 
+                  eg by W dxcc  
    
 e.g. 
    
@@ -1532,17 +1633,26 @@ e.g.
    SH/DX iota 
    SH/DX iota eu-064
    SH/DX qra jn86
+   SH/DX dxcc oq2
+   SH/DX dxcc oq2 by w dxcc
   
 === 0^SHOW/DXCC <prefix>^Interrogate the spot database by country
 This command takes the <prefix> (which can be a full or partial 
 callsign if desired), looks up which internal country number it is
 and then displays all the spots as per SH/DX for that country.
+
+This is now an alias for 'SHOW/DX DXCC' 
    
 The options for SHOW/DX also apply to this command.   
 e.g. 
    
    SH/DXCC G
-   SH/DXCC W on 20m info iota
+   SH/DXCC W on 20m iota
+
+This can be done with the SHOW/DX command like this:-
+
+   SH/DX dxcc g
+   SH/DX dxcc w on 20m iota
 
 === 0^SHOW/DXSTATS^Show the DX Statistics for last 31 days
 Show the total DX spots for the last 31 days