alter the sh/sun and sh/moon help files to reflect the true output
[spider.git] / cmd / Commands_en.hlp
index 055abd0b9e197cbf1b0b8c6ff10185b99d94243d..7dbb0431fe67d8998e432ebc961deee69fe98cc4 100644 (file)
 #
 # Comment lines are indented before printing
 #
+=== 0^ACCEPT^Set a filter to accept something
+Create a filter to accept something
+
+There are 2 types of filter, accept and reject.  See HELP FILTERING for more
+info.
+
 === 0^ACCEPT/ANNOUNCE [0-9] <pattern>^Set an 'accept' filter line for announce
 Create an 'accept this announce' line for a filter. 
 
@@ -497,6 +503,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
@@ -881,6 +920,12 @@ message either sent by or sent to your callsign.
 === 5^READ-^
 As a sysop you may read any message on the system
 
+=== 0^REJECT^Set a filter to reject something
+Create a filter to reject something
+
+There are 2 types of filter, accept and reject.  See HELP FILTERING for more
+info.
+
 === 0^REJECT/ANNOUNCE [0-9] <pattern>^Set a 'reject' filter line for announce
 Create an 'reject this announce' line for a filter. 
 
@@ -1068,6 +1113,48 @@ 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.
+It is likely that you will want to run these commands in a crontab type 
+situation. You would do that something like:-
+
+  0 0 * * * run_cmd('save /tmp/dxstats "echo DXStat Table", "sh/dxstats"')
+
+Note that you still enclose each command with (") characters but you must
+enclose the entire save command in (') characters. 
+
+Now in fact, this can be varied if you know what you are doing. See the
+admin manual for more details.
 === 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
@@ -1078,7 +1165,9 @@ an individual callsign or to one of the 'bulletin' addresses.
 
 SEND <call> on its own acts as though you had typed SEND PRIVATE, that is
 it will mark the message as personal and send it to the cluster node that
-that callsign is connected to.
+that callsign is connected to. If the <call> you have specified is in fact
+a known bulletin category on your node (eg: ALL) then the message should
+automatically become a bulletin.
 
 You can have more than one callsign in all of the SEND commands.
 
@@ -1092,6 +1181,51 @@ receive a read receipt when they have read the message.
 SB is an alias for SEND NOPRIVATE (or send a bulletin in BBS speak)
 SP is an alias for SEND PRIVATE
 
+The system will ask you for a subject. Conventionally this should be 
+no longer than 29 characters for compatibility. Most modern cluster
+software should accept more.
+
+You will now be prompted to start entering your text. 
+
+You finish the message by entering '/EX' on a new line. For instance:
+
+  ...
+  bye then Jim
+  73 Dirk
+  /ex
+
+If you have started a message and you don't want to keep it then you
+can abandon the message with '/ABORT' on a new line, like:-
+
+  line 1
+  line 2
+  oh I just can't be bothered with this
+  /abort
+
+If you abort the message it will NOT be sent.
+
+When you are entering the text of your message, most normal output (such
+as DX announcements and so on are suppressed and stored for latter display
+(upto 20 such lines are stored, as new ones come along, so the oldest
+lines are dropped).
+
+Also, you can enter normal commands commands (and get the output 
+immediately) whilst in the middle of a message. You do this by typing
+the command preceeded by a '/' character on a new line, so:-
+
+  /dx g1tlh 144010 strong signal
+
+Will issue a dx annoucement to the rest of the cluster. 
+
+Also, you can add the output of a command to your message by preceeding 
+the command with '//', thus :-
+
+  //sh/vhftable
+
+This will show YOU the output from SH/VHFTABLE and also store it in the
+message. 
+
+You can carry on with the message until you are ready to send it. 
 === 0^SET/ADDRESS <your address>^Record your postal address
 
 === 0^SET/ANNOUNCE^Allow announce messages to come out on your terminal
@@ -1631,7 +1765,7 @@ 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
+=== 0^SHOW/MOON [ndays] [<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
 locations.
@@ -1640,8 +1774,7 @@ If you don't specify any prefixes or callsigns, it will show the times for
 your QTH (assuming you have set it with either SET/LOCATION or SET/QRA),
 together with the current azimuth and elevation.
 
-In addition, it will show the gain or loss dB relative to the nominal 
-distance of 385,000Km due to the ellipsoidal nature of the orbit.
+In addition, it will show the illuminated fraction of the moons disk.
 
 If all else fails it will show the Moonrise and set times for the node
 that you are connected to. 
@@ -1660,6 +1793,11 @@ or in three days time:-
 
   SH/MOON +3 W9
 
+Upto 366 days can be checked both in the past and in the future.
+
+Please note that the rise and set times are given as the UT times of rise and 
+set on the requested UT day.
+
 === 0^SHOW/MUF <prefix> [<hours>][long]^Show the likely propagation to a prefix
 This command allow you to estimate the likelihood of you contacting
 a station with the prefix you have specified. The output assumes a modest
@@ -1821,7 +1959,7 @@ that callsign is connected to the cluster.
 
 If no callsign is given then show the information for yourself.
 
-=== 0^SHOW/SUN [+/- days][<prefix>|<callsign>]^Show sun rise and set times
+=== 0^SHOW/SUN [ndays] [<prefix>|<callsign>]^Show sun rise and set times
 Show the sun rise and set times for a (list of) prefixes or callsigns, 
 together with the azimuth and elevation of the sun currently at those
 locations.
@@ -1847,6 +1985,11 @@ or in three days time:-
 
   SH/SUN +3 W9
 
+Upto 366 days can be checked both in the past and in the future.
+
+Please note that the rise and set times are given as the UT times of rise 
+and set on the requested UT day.
+
 === 0^SHOW/TIME [<prefix>|<callsign>]^Show the local time 
 If no prefixes or callsigns are given then this command returns the local
 time and UTC as the computer has it right now. If you give some prefixes
@@ -1970,6 +2113,15 @@ To leave talk mode type:
    
    /EX
 
+If you are in 'Talk' mode, there is an extention to the '/' command which
+allows you to send the output to all the people you are talking to. You do 
+with the '//' command. For example:-
+
+  //sh/hftable
+
+will send the hftable as you have it to all the people you are currently 
+talking to.
+
 === 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