add show/grayline command from K9AN
[spider.git] / cmd / Commands_en.hlp
index a15633d3ac6a28918192156f830ce5bbb86d48cc..9e3982cba91851b2ceb1fd28c78e72d95d95a5f6 100644 (file)
@@ -9,6 +9,8 @@
 # if the command ends in a - then that line isn't printed, but any
 # subsequent lines are
 #
+# $Id$
+#
 # Comment lines are indented before printing
 #
 === 0^ACCEPT^Set a filter to accept something
@@ -1570,7 +1572,7 @@ 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), de (German), es (Spanish),
-Czech (cz), Portuguese (pt), Italian (it) and nl (Dutch).
+Czech (cz), French (fr), Portuguese (pt), Italian (it) 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
@@ -1579,8 +1581,8 @@ 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:-
   SET/LOCATION 52 22 N 0 57 E
 
-=== 0^SET/LOGININFO^Inform when a station logs in locally
-=== 0^UNSET/LOGININFO^Inform when a station logs out locally
+=== 0^SET/LOGININFO^Inform when a station logs in/out locally
+=== 0^UNSET/LOGININFO^No longer inform when a station logs in/out locally
 
 === 9^SET/LOCKOUT <call>^Stop a callsign connecting to the cluster
 === 9^UNSET/LOCKOUT <call>^Allow a callsign to connect to the cluster
@@ -1703,19 +1705,26 @@ 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 
+This command will set your user prompt to 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).
+prompt).
 
   SET/PROMPT clx >
 
-UNSET/PROMPT will undo the SET/PROMPT command and set you prompt back to
-normal.
+There are some substitutions that can be added to the prompt:
 
-=== 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.
+  %C - callsign [which will have ( and ) around it if not here]
+  %D - date
+  %T - time
+  %M - cluster 'mycall'
+
+The standard prompt is defined as:
+
+  SET/PROMPT %C de %M %D %T dxspider >
+
+UNSET/PROMPT will undo the SET/PROMPT command and set your prompt back to
+normal.
 
 === 9^SET/SYS_QRA <locator>^Set your cluster QRA Grid locator
 === 0^SET/QRA <locator>^Set your QRA Grid locator
@@ -1744,7 +1753,29 @@ cannot use DX, ANN etc.
 
 The only exception to this is that a non-registered user can TALK or
 SEND messages to the sysop.
+
+=== 6^SET/STARTUP <call>^Create a user startup script
+=== 0^SET/STARTUP^Create your own startup script
+Create a startup script of DXSpider commands which will be executed
+everytime that you login into this node. You can only input the whole
+script afresh, it is not possible to 'edit' it. Inputting a new script is
+just like typing in a message using SEND. To finish inputting type: /EX
+on a newline, to abandon the script type: /ABORT.
+
+You may find the (curiously named) command BLANK useful to break 
+up the output. If you simply want a blank line, it is easier to 
+input one or more spaces and press the <return> key.
+
+See UNSET/STARTUP to remove a script.
+
+=== 6^UNSET/STARTUP <call>^Remove a user startup script
+=== 0^UNSET/STARTUP^Remove your own startup script
+You can remove your startup script with UNSET/STARTUP.  
+
+=== 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.
+
 === 0^SET/TALK^Allow TALK messages to come out on your terminal
 === 0^UNSET/TALK^Stop TALK messages coming out on your terminal
 
@@ -1907,7 +1938,34 @@ any order to the basic SHOW/DX command, they are:-
                   
                    You can also use this with the 'by' keyword so 
                    eg by W dxcc  
-   
+ real or rt      - Format the output the same as for real time spots. The
+                   formats are deliberately different (so you can tell
+                   one sort from the other). This is useful for some 
+                   logging programs that can't cope with normal sh/dx 
+                   output. An alias of SHOW/FDX is available.
+       
+ filter          - Filter the spots, before output, with the user's 
+                   spot filter. An alias of SHOW/MYDX is available.
+
+ zone <zones>    - look for spots in the cq zone (or zones) specified.
+                   zones are numbers separated by commas.
+
+ by_zone <zones> - look for spots spotted by people in the cq zone
+                   specified.
+
+ itu <itus>      - look for spots in the itu zone (or zones) specified
+                   itu zones are numbers separated by commas.
+
+ by_itu <itus>   - look for spots spotted by people in the itu zone
+                   specified.
+  
+ state <list>    - look for spots in the US state (or states) specified
+                   The list is two letter state codes separated by commas.
+
+ by_state <list> - look for spots spotted by people in the US state
+                   specified.
  e.g. 
    
    SH/DX 9m0
@@ -1919,6 +1977,10 @@ any order to the basic SHOW/DX command, they are:-
    SH/DX qra jn86
    SH/DX dxcc oq2
    SH/DX dxcc oq2 by w dxcc
+   SH/DX zone 4,5,6
+   SH/DX by_zone 4,5,6
+   SH/DX state in,oh
+   SH/DX by_state in,oh
   
 === 0^SHOW/DXCC <prefix>^Interrogate the spot database by country
 This command takes the <prefix> (which can be a full or partial 
@@ -1938,6 +2000,16 @@ This can be done with the SHOW/DX command like this:-
    SH/DX dxcc g
    SH/DX dxcc w on 20m iota
 
+This is an alias for: SH/DX dxcc
+
+=== 0^SHOW/FDX^Show the DX data in realtime format.
+Normally SHOW/DX outputs spot data in a different format to the
+realtime data. This is a deliberate policy (so you can tell the 
+difference between the two). Some logging programs cannot handle
+this so SHOW/FDX outputs historical data in real time format.
+
+This is an alias for: SHOW/DX real
+
 === 0^SHOW/DXSTATS [days] [date]^Show the DX Statistics
 Show the total DX spots for the last <days> no of days (default is 31), 
 starting from a <date> (default: today).
@@ -1960,6 +2032,37 @@ See also TYPE - to see the contents of a file.
 Show the contents of all the filters that are set. This command displays
 all the filters set - for all the various categories.
 
+=== 0^SHOW/GRAYLINE [ndays] [<prefix>|<callsign>]^Show Civil dawn/dusk times
+This command is very similar to SHOW/SUN except that it shows the 
+start and end of "Official" or "Civil" Dawn and Dusk. This is defined 
+as when the Sun is 6 degrees below the horizon.
+
+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.
+
+If all else fails it will show the civil dawn and dusk times for 
+the node that you are connected to.
+
+For example:-
+
+  SH/GRAYLINE
+  SH/GRAYLINE G1TLH W5UN
+
+You can also use this command to see into the past or the future, so
+if you want to see yesterday's times then do:-
+
+  SH/GRAYLINE -1
+
+or in three days time:-
+
+  SH/GRAYLINE +3 W9
+
+Upto 366 days can be checked both in the past and in the future.
+
+Please note that the times are given as the UT times of the requested
+UT day.
+       
 === 0^SHOW/HFSTATS [days] [date]^Show the HF DX Statistics 
 Show the HF DX spots breakdown by band for the last <days> no of days 
 (default is 31), starting from a <date> (default: today).
@@ -2113,6 +2216,19 @@ Gives you an estimate of the long path propagation characterics. It
 should be noted that the figures will probably not be very useful, nor
 terrible accurate, but it is included for completeness.
 
+=== 0^SHOW/MYDX^Show the DX data filtered with your spot filter.
+SHOW/DX potentially shows all the spots available in the system. Using
+SHOW/MYDX will, instead, filter the availble spots using any spot filter 
+that you have set, first. 
+
+This command, together with ACCEPT/SPOT or REJECT/SPOT, will allow
+you to customise the spots that you receive.
+
+So if you have said: ACC/SPOT on hf
+
+Doing a SHOW/MYDX will now only, ever, show HF spots. All the other 
+options on SH/DX can still be used.
+
 === 0^SHOW/NEWCONFIGURATION [<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. 
@@ -2220,6 +2336,10 @@ So for example:-
  SH/SAT AO-10 
  SH/SAT FENGYUN1 12 2
 
+=== 6^SHOW/STARTUP <call>^View a user startup script
+=== 0^SHOW/STARTUP^View your own startup script
+View the contents of a startup script created with SET/STARTUP.
+
 === 6^SHOW/STATION ALL [<regex>]^Show list of users in the system
 === 0^SHOW/STATION [<callsign> ..]^Show information about a callsign
 Show the information known about a callsign and whether (and where)