put dx.pl into an explicit handle sub
[spider.git] / sgml / adminmanual_en.sgml
index 8615eff63f28cf0322ba41bbca60ee109a8acf53..d8767a879cd5d1f344770a7124e32b1bdc9a175b 100644 (file)
@@ -4,10 +4,10 @@
 \r
 <!-- Title information -->\r
 \r
-<title>The DXSpider Administration Manual v1.50</title> \r
+<title>The DXSpider Administration Manual v1.51</title> \r
 <author>Ian Maude, G0VGS, (g0vgs@gb7mbc.net), and\r
 Charlie Carroll, K1XX, (k1xx@ptcnh.net)</author>\r
-<date>April 2003 revision 0.7</date>\r
+<date>June 2004 revision 1</date>\r
 \r
 <abstract>\r
 A reference for SysOps of the DXSpider DXCluster program.\r
@@ -1647,7 +1647,7 @@ First login as the user <em>sysop</em>.  Next you need to connect to the CVS
 repository.  You do this with the command below ...\r
 \r
 <verb>\r
-cvs -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login\r
+cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/dxspider login\r
 </verb>\r
 \r
 You will get a password prompt.  Simply hit return here and your machine should\r
@@ -1667,7 +1667,7 @@ The next step will create a brand new 'spider' directory in your current
 directory.\r
 \r
 <verb>\r
-cvs -z3 -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider co spider\r
+cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/dxspider co spider\r
 </verb>\r
 \r
 This command is all on one line.\r
@@ -1757,7 +1757,7 @@ should get you:
 \r
 In the top line for CVSROOT, enter:\r
 <tscreen><verb>\r
-anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login\r
+anonymous@cvs.sourceforge.net:/cvsroot/dxspider login\r
 </verb></tscreen>\r
 \r
 and select\r
@@ -4314,8 +4314,8 @@ You can potentially connect several nodes in this way.
 
 <P>
 You can select the language that you want the cluster to use. Currently
-the languages available are en (English), de (German), es (Spanish) 
-and nl (Dutch).
+the languages available are en (English), de (German), es (Spanish),
+Czech (cz), French (fr), Portuguese (pt), Italian (it) and nl (Dutch).
 <sect1>set/location &lt;lat & long&gt; (0)
 
 <P>
@@ -4336,7 +4336,7 @@ and nl (Dutch).
 
 <P>
 <tt>
-<bf>set/logininfo</bf> Inform when a station logs in locally
+<bf>set/logininfo</bf> Inform when a station logs in/out locally
 </tt>
 
 <P>
@@ -4559,6 +4559,33 @@ Tell the system where you are. For example:-
 <P>
 Tell the system that the call(s) are to be treated as DXSpider node and
 fed new style DX Protocol rather normal user commands.
+<sect1>set/startup (0)
+
+<P>
+<tt>
+<bf>set/startup</bf> Create your own startup script
+</tt>
+
+<P>
+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 &lt;return&gt; key.
+
+See UNSET/STARTUP to remove a script.
+<sect1>set/startup &lt;call&gt; (6)
+
+<P>
+<tt>
+<bf>set/startup &lt;call&gt;</bf> Create a user startup script
+</tt>
+
+<P>
 <sect1>set/sys_location &lt;lat & long&gt; (9)
 
 <P>
@@ -4874,7 +4901,50 @@ any order to the basic SHOW/DX command, they are:-
                    You can also use this with the 'by' keyword so 
                    eg by W dxcc  
 </verb></tscreen>
-   
+<tscreen><verb>
+ 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.
+</verb></tscreen>
+       
+<tscreen><verb>
+ filter          - Filter the spots, before output, with the user's 
+                   spot filter. An alias of SHOW/MYDX is available.
+</verb></tscreen>
+
+<tscreen><verb>
+ zone &lt;zones&gt;    - look for spots in the cq zone (or zones) specified.
+                   zones are numbers separated by commas.
+</verb></tscreen>
+
+<tscreen><verb>
+ by_zone &lt;zones&gt; - look for spots spotted by people in the cq zone
+                   specified.
+</verb></tscreen>
+
+<tscreen><verb>
+ itu &lt;itus&gt;      - look for spots in the itu zone (or zones) specified
+                   itu zones are numbers separated by commas.
+</verb></tscreen>
+
+<tscreen><verb>
+ by_itu &lt;itus&gt;   - look for spots spotted by people in the itu zone
+                   specified.
+</verb></tscreen>
+  
+<tscreen><verb>
+ state &lt;list&gt;    - look for spots in the US state (or states) specified
+                   The list is two letter state codes separated by commas.
+</verb></tscreen>
+
+<tscreen><verb>
+ by_state &lt;list&gt; - look for spots spotted by people in the US state
+                   specified.
+</verb></tscreen>
 <tscreen><verb>
  e.g. 
 </verb></tscreen>
@@ -4889,6 +4959,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
 </verb></tscreen>
   
 <sect1>show/dxcc &lt;prefix&gt; (0)
@@ -4920,6 +4994,7 @@ This can be done with the SHOW/DX command like this:-
    SH/DX dxcc w on 20m iota
 </verb></tscreen>
 
+This is an alias for: SH/DX dxcc
 <sect1>show/dxqsl &lt;callsign&gt; (0)
 
 <P>
@@ -4959,6 +5034,20 @@ This gives you more background information.
 <P>
 Show the total DX spots for the last &lt;days&gt; no of days (default is 31), 
 starting from a &lt;date&gt; (default: today).
+<sect1>show/fdx (0)
+
+<P>
+<tt>
+<bf>show/fdx</bf> Show the DX data in realtime format.
+</tt>
+
+<P>
+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
 <sect1>show/files &lsqb;&lt;filearea&gt; &lsqb;&lt;string&gt;&rsqb;&rsqb; (0)
 
 <P>
@@ -5218,6 +5307,25 @@ propagation data.
 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.
+<sect1>show/mydx (0)
+
+<P>
+<tt>
+<bf>show/mydx</bf> Show the DX data filtered with your spot filter.
+</tt>
+
+<P>
+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.
 <sect1>show/newconfiguration &lsqb;&lt;node&gt;&rsqb; (0)
 
 <P>
@@ -5384,6 +5492,23 @@ So for example:-
  SH/SAT FENGYUN1 12 2
 </verb></tscreen>
 
+<sect1>show/startup (0)
+
+<P>
+<tt>
+<bf>show/startup</bf> View your own startup script
+</tt>
+
+<P>
+View the contents of a startup script created with SET/STARTUP.
+<sect1>show/startup &lt;call&gt; (6)
+
+<P>
+<tt>
+<bf>show/startup &lt;call&gt;</bf> View a user startup script
+</tt>
+
+<P>
 <sect1>show/station all &lsqb;&lt;regex&gt;&rsqb; (6)
 
 <P>
@@ -6171,7 +6296,7 @@ Remove isolation from a node - SET/ISOLATE
 
 <P>
 <tt>
-<bf>unset/logininfo</bf> Inform when a station logs out locally
+<bf>unset/logininfo</bf> No longer inform when a station logs in/out locally
 </tt>
 
 <P>
@@ -6205,16 +6330,31 @@ SYSOP command.
 </tt>
 
 <P>
-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).
 
 <tscreen><verb>
   SET/PROMPT clx &gt;
 </verb></tscreen>
 
-UNSET/PROMPT will undo the SET/PROMPT command and set you prompt back to
+There are some substitutions that can be added to the prompt:
+
+<tscreen><verb>
+  %C - callsign [which will have ( and ) around it if not here]
+  %D - date
+  %T - time
+  %M - cluster 'mycall'
+</verb></tscreen>
+
+The standard prompt is defined as:
+
+<tscreen><verb>
+  SET/PROMPT %C de %M %D %T dxspider &gt;
+</verb></tscreen>
+
+UNSET/PROMPT will undo the SET/PROMPT command and set your prompt back to
 normal.
 <sect1>unset/register &lt;call&gt; ... (9)
 
@@ -6240,7 +6380,23 @@ cannot use DX, ANN etc.
 
 The only exception to this is that a non-registered user can TALK or
 SEND messages to the sysop.
+<sect1>unset/startup (0)
+
+<P>
+<tt>
+<bf>unset/startup</bf> Remove your own startup script
+</tt>
+
+<P>
+You can remove your startup script with UNSET/STARTUP.  
+<sect1>unset/startup &lt;call&gt; (6)
+
+<P>
+<tt>
+<bf>unset/startup &lt;call&gt;</bf> Remove a user startup script
+</tt>
+
+<P>
 <sect1>unset/talk (0)
 
 <P>