<!-- 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>September 2002 revision 0.1</date>
+<date>June 2004 revision 1</date>
<abstract>
A complete reference for users of the DXSpider DXCluster program.
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.
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
+<sect>The DXSpider Command Reference
<sect1>accept
<P>
This will disconnect you from the cluster
+<sect1>chat <group> <text>
+
+<P>
+<tt>
+<bf>chat <group> <text></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/<group>).
+
+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 [1|all]
<P>
Look at the APROPOS <string> command which will search the help database
for the <string> you specify and give you a list of likely commands
to look at with HELP.
+<sect1>join <group>
+
+<P>
+<tt>
+<bf>join <group></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 <from msgno>-<to msgno>
<P>
</tt>
<P>
+<sect1>leave <group>
+
+<P>
+<tt>
+<bf>leave <group></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>
<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
</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>
<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 <lat & long>
<P>
<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>
SET/QTH East Dereham, Norfolk
</verb></tscreen>
+<sect1>set/startup
+
+<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 <return> key.
+
+See UNSET/STARTUP to remove a script.
<sect1>set/talk
<P>
<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
</tt>
<P>
+<sect1>show/chat [<group>] [<lines>]
+
+<P>
+<tt>
+<bf>show/chat [<group>] [<lines>]</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 [<node>]
<P>
<P>
Show all the nodes connected to this node.
+<sect1>show/contest <year and month>
+
+<P>
+<tt>
+<bf>show/contest <year and month></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 [<prefix>|<callsign>]
<P>
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 <zones> - look for spots in the cq zone (or zones) specified.
+ zones are numbers separated by commas.
+</verb></tscreen>
+
+<tscreen><verb>
+ by_zone <zones> - look for spots spotted by people in the cq zone
+ specified.
+</verb></tscreen>
+
+<tscreen><verb>
+ itu <itus> - look for spots in the itu zone (or zones) specified
+ itu zones are numbers separated by commas.
+</verb></tscreen>
+
+<tscreen><verb>
+ by_itu <itus> - look for spots spotted by people in the itu zone
+ specified.
+</verb></tscreen>
+
+<tscreen><verb>
+ state <list> - 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 <list> - look for spots spotted by people in the US state
+ specified.
+</verb></tscreen>
+
<tscreen><verb>
e.g.
</verb></tscreen>
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 <prefix>
SH/DX dxcc w on 20m iota
</verb></tscreen>
+This is an alias for: SH/DX dxcc
+<sect1>show/dxqsl <callsign>
+
+<P>
+<tt>
+<bf>show/dxqsl <callsign></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 [days] [date]
<P>
<P>
Show the total DX spots for the last <days> no of days (default is 31),
starting from a <date> (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 [<filearea> [<string>]]
<P>
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 [<node>]
<P>
SH/SAT FENGYUN1 12 2
</verb></tscreen>
+<sect1>show/startup
+
+<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/station [<callsign> ..]
<P>
</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>
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>
<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>
</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 >
</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 >
+</verb></tscreen>
+
+UNSET/PROMPT will undo the SET/PROMPT command and set your prompt back to
normal.
+<sect1>unset/startup
+
+<P>
+<tt>
+<bf>unset/startup</bf> Remove your own startup script
+</tt>
+
+<P>
+You can remove your startup script with UNSET/STARTUP.
<sect1>unset/talk
<P>
</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>
projects / spider.git / blobdiff