Link the filtering manual from the admin and user manuals (g0vgs)
[spider.git] / sgml / usermanual_en.sgml
index bac44d2f1d530817168be209a1dc1337d8119e13..ade4c0d94ad5e25a100900e41eb3d66a614cff61 100644 (file)
@@ -6,7 +6,7 @@
 
 <title>The DXSpider User Manual v1.50</title> 
 <author>Ian Maude, G0VGS, (g0vgs@gb7mbc.net)</author>
-<date>September 2002 revision 0.1</date>
+<date>March 2003 revision 0.4</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,7 +1015,6 @@ 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
 
@@ -1273,6 +1279,60 @@ of 9 lines.
 
 <P>
 This will disconnect you from the cluster
+<sect1>chat &lt;group&gt; &lt;text&gt;
+
+<P>
+<tt>
+<bf>chat &lt;group&gt; &lt;text&gt;</bf> Chat or Conference to a group
+</tt>
+
+<P>
+It is now possible to JOIN a group and have network wide conferencing to that
+group. DXSpider does not (and probably will not) implement the AK1A 
+conference mode as this seems very limiting, is hardly used and doesn't seem
+to work too well anyway.
+
+This system uses the existing ANN system and is compatible with both other
+DXSpider nodes and AK1A clusters (they use ANN/&lt;group&gt;). 
+
+You can be a member of as many "groups" as you want. To join a group type:-
+
+<tscreen><verb>
+  JOIN FOC    (where FOC is the group name)
+</verb></tscreen>
+
+To leave a group type:-
+
+<tscreen><verb>
+  LEAVE FOC
+</verb></tscreen>
+
+You can see which groups you are in by typing:-
+
+<tscreen><verb>
+  STAT/USER
+</verb></tscreen>
+
+and you can see whether your mate is in the group, if he connects to the
+same node as you, by typing:-
+
+<tscreen><verb>
+  STAT/USER g1tlh
+</verb></tscreen>
+
+To send a message to a group type:-
+
+<tscreen><verb>
+  CHAT FOC hello everyone
+</verb></tscreen>
+
+or
+
+<tscreen><verb>
+  CH #9000 hello I am back
+</verb></tscreen>
+
+See also JOIN, LEAVE, SHOW/CHAT
 <sect1>clear/announce &lsqb;1|all&rsqb;
 
 <P>
@@ -1766,6 +1826,22 @@ to SH/DX, ANNOUNCE can be shortened to AN and so on.
 Look at the APROPOS &lt;string&gt; command which will search the help database
 for the &lt;string&gt; you specify and give you a list of likely commands
 to look at with HELP.
+<sect1>join &lt;group&gt;
+
+<P>
+<tt>
+<bf>join &lt;group&gt;</bf> Join a chat or conference group
+</tt>
+
+<P>
+JOIN allows you to join a network wide conference group. To join a
+group (called FOC in this case) type:-
+
+<tscreen><verb>
+  JOIN FOC
+</verb></tscreen>
+
+See also CHAT, LEAVE, SHOW/CHAT
 <sect1>kill &lt;from msgno&gt;-&lt;to msgno&gt;
 
 <P>
@@ -1808,6 +1884,22 @@ this command. You can remove more than one message at a time.
 </tt>
 
 <P>
+<sect1>leave &lt;group&gt;
+
+<P>
+<tt>
+<bf>leave &lt;group&gt;</bf> Leave a chat or conference group
+</tt>
+
+<P>
+LEAVE allows you to leave a network wide conference group. To leave a
+group (called FOC in this case) type:-
+
+<tscreen><verb>
+  LEAVE FOC
+</verb></tscreen>
+
+See also CHAT, JOIN, SHOW/CHAT
 <sect1>links
 
 <P>
@@ -2213,6 +2305,14 @@ You can carry on with the message until you are ready to send it.
 <bf>set/dx</bf> Allow DX messages to come out on your terminal
 </tt>
 
+<P>
+<sect1>set/dxcq
+
+<P>
+<tt>
+<bf>set/dxcq</bf> Show CQ Zones on the end of DX announcements
+</tt>
+
 <P>
 <sect1>set/dxgrid
 
@@ -2222,11 +2322,11 @@ You can carry on with the message until you are ready to send it.
 </tt>
 
 <P>
-<sect1>set/dxstate
+<sect1>set/dxitu
 
 <P>
 <tt>
-<bf>set/dxstate</bf> Allow US State info on the end of DX announcements
+<bf>set/dxitu</bf> Show ITU Zones on the end of DX announcements
 </tt>
 
 <P>
@@ -2385,6 +2485,14 @@ Tell the system where you are. For example:-
 <bf>set/talk</bf> Allow TALK messages to come out on your terminal
 </tt>
 
+<P>
+<sect1>set/usstate
+
+<P>
+<tt>
+<bf>set/usstate</bf> Allow US State info on the end of DX announcements
+</tt>
+
 <P>
 <sect1>set/wcy
 
@@ -2410,6 +2518,18 @@ Tell the system where you are. For example:-
 </tt>
 
 <P>
+<sect1>show/chat &lsqb;&lt;group&gt;&rsqb; &lsqb;&lt;lines&gt;&rsqb;
+
+<P>
+<tt>
+<bf>show/chat &lsqb;&lt;group&gt;&rsqb; &lsqb;&lt;lines&gt;&rsqb;</bf> Show any chat or conferencing 
+</tt>
+
+<P>
+This command allows you to see any chat or conferencing that has  
+occurred whilst you were away. SHOW/CHAT on its own will show data for
+all groups. If you use a group name then it will show only chat for
+that group.
 <sect1>show/configuration &lsqb;&lt;node&gt;&rsqb;
 
 <P>
@@ -2455,6 +2575,23 @@ that prefix.
 
 <P>
 Show all the nodes connected to this node.
+<sect1>show/contest &lt;year and month&gt;
+
+<P>
+<tt>
+<bf>show/contest &lt;year and month&gt;</bf> Show all the contests for a month
+</tt>
+
+<P>
+Show all known contests which are maintained at http://www.sk3bg.se/contest/
+for a particular month or year. The format is reasonably flexible.
+For example:-
+  
+<tscreen><verb>
+  SH/CONTEST sep2003
+  SH/CONTEST 03 march
+</verb></tscreen>
+
 <sect1>show/date &lsqb;&lt;prefix&gt;|&lt;callsign&gt;&rsqb;
 
 <P>
@@ -2604,6 +2741,35 @@ This can be done with the SHOW/DX command like this:-
    SH/DX dxcc w on 20m iota
 </verb></tscreen>
 
+<sect1>show/dxqsl &lt;callsign&gt;
+
+<P>
+<tt>
+<bf>show/dxqsl &lt;callsign&gt;</bf> Show any QSL info gathered from spots
+</tt>
+
+<P>
+The node collects information from the comment fields in spots (things
+like 'VIA EA7WA' or 'QSL-G1TLH') and stores these in a database.
+
+This command allows you to interrogate that database and if the callsign
+is found will display the manager(s) that people have spotted. This 
+information is NOT reliable, but it is normally reasonably accurate if
+it is spotted enough times.
+
+For example:-
+
+<tscreen><verb>
+  sh/dxqsl 4k9w
+</verb></tscreen>
+
+You can check the raw input spots yourself with:-
+
+<tscreen><verb>
+  sh/dx 4k9w qsl
+</verb></tscreen>
+
+This gives you more background information.
 <sect1>show/dxstats &lsqb;days&rsqb; &lsqb;date&rsqb;
 
 <P>
@@ -3327,6 +3493,22 @@ allows you to see them again. This is the default.
 </tt>
 
 <P>
+<sect1>unset/dxcq
+
+<P>
+<tt>
+<bf>unset/dxcq</bf> Stop CQ Zones on the end of DX announcements
+</tt>
+
+<P>
+Display both the Spotter's and the Spotted's CQ Zone on the end
+of a DX announcement (there is just enough room). Some user programs
+cannot cope with this. The Spotter's CQ is on the RHS of the 
+time, the Spotted's CQ is on the LHS.
+
+Conflicts with: SET/DXGRID, SET/DXITU, SHOW/USSTATE
+
+Do a STAT/USER to see which flags you have set if you are confused.  
 <sect1>unset/dxgrid
 
 <P>
@@ -3340,24 +3522,26 @@ that if the spotter's grid square is known it is output on the end
 of a DX announcement (there is just enough room). Some user programs
 cannot cope with this. You can use this command to reset (or set)
 this feature.
-<sect1>unset/dxstate
+
+Conflicts with: SET/DXCQ, SET/DXITU
+
+Do a STAT/USER to see which flags you have set if you are confused.  
+<sect1>unset/dxitu
 
 <P>
 <tt>
-<bf>unset/dxstate</bf> Stop US State info on the end of DX announcements
+<bf>unset/dxitu</bf> Stop ITU Zones on the end of DX announcements
 </tt>
 
 <P>
-If the spotter's or spotted's US State is known it is output on the 
-end of a DX announcement (there is just enough room). 
+Display both the Spotter's and the Spotted's ITU Zone on the end
+of a DX announcement (there is just enough room). Some user programs
+cannot cope with this. The Spotter's ITU is on the RHS of the 
+time, the Spotted's ITU is on the LHS.
 
-A spotter's state will appear on the RHS of the time (like 
-SET/DXGRID) and the spotted's State will appear on the LHS of the
-time field. Any information found will override any locator 
-information from SET/DXGRID.
+Conflicts with: SET/DXGRID, SET/DXCQ, SHOW/USSTATE
 
-Some user programs cannot cope with this. You can use this command 
-to reset (or set) this feature.
+Do a STAT/USER to see which flags you have set if you are confused.  
 <sect1>unset/echo
 
 <P>
@@ -3454,6 +3638,28 @@ normal.
 </tt>
 
 <P>
+<sect1>unset/usstate
+
+<P>
+<tt>
+<bf>unset/usstate</bf> Stop US State info on the end of DX announcements
+</tt>
+
+<P>
+If the spotter's or spotted's US State is known it is output on the 
+end of a DX announcement (there is just enough room). 
+
+A spotter's state will appear on the RHS of the time (like 
+SET/DXGRID) and the spotted's State will appear on the LHS of the
+time field. Any information found will override any locator 
+information from SET/DXGRID.
+
+Some user programs cannot cope with this. You can use this command 
+to reset (or set) this feature.
+
+Conflicts with: SET/DXCQ, SET/DXITU
+
+Do a STAT/USER to see which flags you have set if you are confused.  
 <sect1>unset/wcy
 
 <P>