# 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
Order is not important.
+=== 0^CHAT <group> <text>^Chat or Conference to a group
+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:-
+
+ JOIN FOC (where FOC is the group name)
+
+To leave a group type:-
+
+ LEAVE FOC
+
+You can see which groups you are in by typing:-
+
+ STAT/USER
+
+and you can see whether your mate is in the group, if he connects to the
+same node as you, by typing:-
+
+ STAT/USER g1tlh
+
+To send a message to a group type:-
+
+ CHAT FOC hello everyone
+
+or
+
+ CH #9000 hello I am back
+
+See also JOIN, LEAVE, SHOW/CHAT
+
=== 0^CLEAR/ANNOUNCE [1|all]^Clear a announce filter line
This command allows you to clear (remove) a line in a annouce filter or to
remove the whole filter.
effects. Commands are run at the privilege of the user which is being
demonstrated to.
+=== 0^JOIN <group>^Join a chat or conference group
+JOIN allows you to join a network wide conference group. To join a
+group (called FOC in this case) type:-
+
+ JOIN FOC
+
+See also CHAT, LEAVE, SHOW/CHAT
+
=== 0^KILL <msgno> [<msgno..]^Delete a message from the local system
=== 0^KILL <from msgno>-<to msgno>^Delete a range of messages
=== 0^KILL from <regex>^Delete messages FROM a callsign or pattern
It otherwise is used in the same way as the KILL command.
+=== 0^LEAVE <group>^Leave a chat or conference group
+LEAVE allows you to leave a network wide conference group. To leave a
+group (called FOC in this case) type:-
+
+ LEAVE FOC
+
+See also CHAT, JOIN, SHOW/CHAT
+
=== 0^LINKS^Show which nodes is physically connected
This is a quick listing that shows which links are connected and
some information about them. See WHO for a list of all connections.
Use with extreme care. This command may well be superceded by FILTERing.
+This command will also stop TALK and ANNOUNCE/FULL from any user marked
+as a BADSPOTTER.
+
=== 8^SET/BADWORD <word>..^Stop things with this word being propagated
=== 8^UNSET/BADWORD <word>..^Propagate things with this word again
Setting a word as a 'badword' will prevent things like spots,
=== 5^SET/BBS <call> [<call>..]^Make the callsign a BBS
+=== 0^SET/BUDDY <call> [<call>..]^Add this call to my buddy list
+=== 0^UNSET/BUDDY <call> [<call>..]^Remove this call from my buddy list
+A notification message
+is sent to you automatically if anybody on your buddy list logs in or
+out of any node in this cluster.
+
=== 5^SET/CLX <call> [<call>..]^Make the callsign an CLX node
=== 9^SET/DEBUG <name>^Add a debug level to the debug set
=== 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)
-and nl (Dutch).
+the languages available are en (English), de (German), es (Spanish),
+Czech (cz), French (fr), Portuguese (pt), Italian (it) and nl (Dutch).
+
+=== 5^SET/LOCAL_NODE^Add node to the local_node group
+=== 5^UNSET/LOCAL_NODE^Remove node from the local_node group
+The 'local_node' group is a group of nodes that you want a user
+to perceive as effectively one big node. At the moment, this extends
+only to announcing whenever a user is logging in or out of one of
+the nodes in the group (if those users have SET/LOGININFO).
+
+The local node group is as setup on this node. If you want the other
+nodes to also include this node and all the other nodes specified, then
+you must get those nodes to also run this command (or rcmd them to do
+so).
+
+In principle, therefore, each node determines its own local node group
+and these can overlap with other nodes' views.
=== 0^SET/LOCATION <lat & long>^Set your latitude and longitude
=== 9^SET/SYS_LOCATION <lat & long>^Set your cluster latitude and longitude
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
=== 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
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
Display all the bad words in the system, see SET/BADWORD
for more information.
+=== 0^SHOW/BUDDY^Show your list of buddies
+See SET/BUDDY for more information about buddies.
+
+=== 0^SHOW/CHAT [<group>] [<lines>]^Show any chat or conferencing
+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.
+
=== 0^SHOW/CONFIGURATION [<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.
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
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
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).
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).
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.
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)
projects / spider.git / blobdiff