# if the command ends in a - then that line isn't printed, but any
# subsequent lines are
#
+#
+#
# Comment lines are indented before printing
#
=== 0^ACCEPT^Set a filter to accept something
A sysop can clear an input or normal output filter for a user or the
node_default or user_default.
+=== 6^CLEAR/DUPEFILE^Clear out the dupefile completely
+The system maintains a list of duplicate announces and spots (amongst many
+other things). Sometimes this file gets corrupted during operation
+(although not very often). This command will remove the file and start
+again from scratch.
+
+Try this if you get several duplicate DX Spots, one after another.
+
+Please ONLY use this command if you have a problem. And then only once.
+If it does not cure your problem, then repeating the command won't help.
+Get onto the dxspider-support list and let us try to help.
+
+If you use this command frequently then you will cause other people, as
+well as yourself, a lot of problems with duplicates.
+
=== 0^CLEAR/ROUTE [1|all]^Clear a route filter line
This command allows you to clear (remove) a line in a route filter or to
remove the whole filter.
use the script in /spider/connect/<callsign> to effect the 'chat' exchange
necessary to traverse the network(s) to logon to the cluster <callsign>.
+=== 5^CREATE/USER <callsign> ...^Create this user from the User Database
+This command will create one or more new users. None of the fields
+like name, qth etc will be filled in. It is just a new entry in the user
+database to which one can add more stuff like SET/PASSWORD or by SPOOF.
+
=== 9^DELETE/USDB <callsign> ...^Delete this user from the US State Database
This command will completely remove a one or more callsigns
from the US States database.
=== 5^DIRECTORY-^
Sysops can see all users' messages.
-=== 8^DISCONNECT <call> [<call> ...]^Disconnect a user or cluster
-Disconnect any <call> connected locally
+=== 8^DISCONNECT <call> [<call> ...]^Disconnect user(s) or node(s)
+Disconnect any <call> connected locally.
+
+In addition you can disconnect all users (except yourself) with
+
+ DISC users
+
+or all nodes with:
+
+ DISC nodes
+
+or everything (except yourself) with
+
+ DISC all
=== 0^DX [BY <call>] <freq> <call> <remarks>^Send a DX spot
This is how you send a DX Spot to other users. You can, in fact, now
can get confused if you are doing a lot of moving commands about or
delete a command in the local_cmd tree and want to use the normal one
again. Execute this command to reset everything back to the state it
-was just after a cluster restart.
+was just after a cluster restart. To see what is in the command cache
+see SHOW/CMD_CACHE.
=== 9^LOAD/FORWARD^Reload the msg forwarding routing table
Reload the /spider/msg/forward.pl file if you have changed it
You can carry on with the message until you are ready to send it.
=== 0^SET/ADDRESS <your address>^Record your postal address
+=== 9^SET/AGWENGINE^Enable the AGW Engine
+=== 9^UNSET/AGWENGINE^Disable the AGW Engine
+These commands assume that /spider/local/AGWConnect.pm has been setup
+correctly and you wish to do some testing or otherwise want to alter
+the default state of your connection to the AGW Engine.
+
+=== 9^SET/AGWMONITOR^Enable Monitoring on the AGW Engine
+=== 9^UNSET/AGWMONITOR^Disable Monitoring on the AGW Engine
+
=== 0^SET/ANNOUNCE^Allow announce messages to come out on your terminal
=== 0^UNSET/ANNOUNCE^Stop announce messages coming out on your terminal
=== 5^SET/ARCLUSTER <call> [<call>..]^Make the callsign an AR-Cluster node
-=== 8^SET/BADDX <call>..^Stop callsigns in a dx spot being propagated
-=== 8^UNSET/BADDX <call>..^Propagate a dx spot with this callsign again
+=== 6^SET/BADDX <call>..^Stop callsigns in a dx spot being propagated
+=== 6^UNSET/BADDX <call>..^Propagate a dx spot with this callsign again
Setting a word as 'baddx' will prevent spots with that word in the
'spotted' field (as in: DX 14001.1 FR0G)of a DX spot from going any
further. They will not be displayed and they will not be sent onto
unset/baddx VIDEO
-=== 8^SET/BADNODE <call>..^Stop spots from this node being propagated
-=== 8^UNSET/BADNODE <call>..^Allow spots from this node again
+=== 6^SET/BADNODE <call>..^Stop spots from this node being propagated
+=== 6^UNSET/BADNODE <call>..^Allow spots from this node again
Setting a callsign as a 'badnode' will prevent spots from that node
going any further. They will not be displayed and they will not be
sent onto other nodes.
Use with extreme care. This command may well be superceeded by FILTERing.
-=== 8^SET/BADSPOTTER <call>..^Stop spots from this callsign being propagated
-=== 8^UNSET/BADSPOTTER <call>..^Allow spots from this callsign again
+=== 6^SET/BADSPOTTER <call>..^Stop spots from this callsign being propagated
+=== 6^UNSET/BADSPOTTER <call>..^Allow spots from this callsign again
Setting a callsign as a 'badspotter' will prevent spots from this callsign
going any further. They will not be displayed and they will not be
sent onto other nodes.
Use with extreme care. This command may well be superceded by FILTERing.
-=== 8^SET/BADWORD <word>..^Stop things with this word being propagated
-=== 8^UNSET/BADWORD <word>..^Propagate things with this word again
+This command will also stop TALK and ANNOUNCE/FULL from any user marked
+as a BADSPOTTER.
+
+=== 6^SET/BADWORD <word>..^Stop things with this word being propagated
+=== 6^UNSET/BADWORD <word>..^Propagate things with this word again
Setting a word as a 'badword' will prevent things like spots,
announces or talks with this word in the the text part from going any
further. They will not be displayed and they will not be sent onto
=== 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
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
In order to get accurate headings and such like you must tell the system
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
=== 0^SET/WX^Allow WX messages to come out on your terminal
=== 0^UNSET/WX^Stop WX messages coming out on your terminal
+=== 0^SHOW/ANNOUNCE [<n>][<from>-<to>][<call>] ...^Show log of announces
+Show announcements that have come in.
+
=== 1^SHOW/BADDX^Show all the bad dx calls in the system
Display all the bad dx callsigns in the system, see SET/BADDX
for more information.
Display all the bad words in the system, see SET/BADWORD
for more information.
+=== 0^SHOW/BANDS [band|region names]^Show the list of bands and regions
+Display the bands and regions (collections of bands) known to
+the system. If you supply band or region names to SHOW/BANDS,
+the command will display just those bands or regions, e.g.:
+
+ sh/band
+ sh/band 2m hf
+
+=== 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.
+=== 9^SHOW/CMD_CACHE [pattern]^Show the real source path of commands
+It is possible in DXSpider to define local versions of commands.
+Sometimes one forgets that one has these. This command will show you
+the source path where the node is getting each one of its commands.
+
+If you find a local command that you don't want then then simply
+delete it, run LOAD/CMD_CACHE to clear out the command cache and
+try again. You will now be using the standard version.
+
+If you are looking for information on a specific command then
+just add a string, eg:
+
+ sh/cmd dx
+
+might give you:
+
+ Command Path
+ set/dxgrid /spider/cmd/set/dxgrid.pl
+ sh/dx /spider/cmd/show/dx.pl
+
=== 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.
<prefix> - for a spotted callsign beginning with <prefix>
*<suffix> - for a spotted callsign ending in <suffix>
*<string>* - for a spotted callsign containing <string>
+ <call> exact - for a spotted callsign *exactly* as typed.
day <number> - starting <number> days ago
day <from>-<to> - <from> days <to> days ago
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
+ 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
+ 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
+ SH/DX hb2008g exact
=== 0^SHOW/DXCC <prefix>^Interrogate the spot database by country
This command takes the <prefix> (which can be a full or partial
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).
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.
+=== 0^SHOW/NEWCONFIGURATION [USERS|<node call>]^Show the cluster map
+Show the map of the whole cluster.
-This command produces essentially the same information as
-SHOW/CONFIGURATION except that it shows all the duplication of
-any routes that might be present It also uses a different format
-which may not take up quite as much space if you don't have any
-loops.
+This shows the structure of the cluster that you are connected to. By
+default it will only show the nodes that are known. By adding the keyword
+USER to the command it will show all the users as well.
-BE WARNED: the list that is returned can be VERY long
+As there will be loops, you will see '...', this means that the information
+is as printed earlier and that is a looped connection from here on.
+
+BE WARNED: the list that is returned can be VERY long (particularly
+with the USER keyword)
=== 0^SHOW/NEWCONFIGURATION/NODE^Show all the nodes connected locally
Show all the nodes connected to this node in the new format.
sh/route n2tly
+=== 9^SHOW/RCMD [<n>][<from>-<to>][<call>] ...^Show log of rcmds
+Show the rcmds that have come in and their replies.
+
=== 0^SHOW/SATELLITE <name> [<hours> <interval>]^Show tracking data
Show the tracking data from your location to the satellite of your choice
from now on for the next few hours.
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