Update manuals for CVS and new commands

[spider.git] / sgml / usermanual_en.sgml

diff --git a/sgml/usermanual_en.sgml b/sgml/usermanual_en.sgml
index ce7611a46c29a81a098d0c1fe04ffaefe6a3a781..4bd3cd930edc9b1abe560069b8d08ac2667d0719 100644 (file)
--- a/sgml/usermanual_en.sgml
+++ b/sgml/usermanual_en.sgml
@@ -4,9 +4,9 @@
 
 <!-- Title information -->
 
-<title>The DXSpider User Manual v1.50</title> 
+<title>The DXSpider User Manual v1.51</title> 
 <author>Ian Maude, G0VGS, (g0vgs@gb7mbc.net)</author>
-<date>March 2003 revision 0.3</date>
+<date>June 2004 revision 1</date>
 
 <abstract>
 A complete reference for users of the DXSpider DXCluster program.
@@ -962,6 +962,13 @@ In the example what happens is that the reject is executed first, any non
 hf/cw spot is passed to the accept line, which lets through everything 
 else on HF.  The next filter line lets through just VHF/UHF spots from EU.
 
+<sect1>A Filtering Tutorial
+
+<P>
+There is now an excellent primer/tutorial on filtering written by Jim
+Samuels, W3BG with an introduction by Dave Hawes N3RD that I strongly
+suggest you read.  You can read it here
+<htmlurl url="filtering_en.html" name="The DXSpider User Filtering Primer">
 
 <sect>Hints, tips and common questions.
 
@@ -1008,6 +1015,7 @@ user manual?
 also be included with every release of DXSpider.  As always, if unsure,
 ask your sysop what version number is the latest. 
 
+<sect>The DXSpider Command Reference
 
 <sect1>accept
 
@@ -2371,8 +2379,8 @@ eg:-
 
 <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;
 
 <P>
@@ -2688,7 +2696,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>
@@ -2703,6 +2754,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;
@@ -2734,6 +2789,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;
 
 <P>
@@ -2773,6 +2829,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
+
+<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;
 
 <P>
@@ -2993,6 +3063,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
+
+<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;
 
 <P>