tidied up the filtering help a bit

[spider.git] / cmd / Commands_en.hlp

#
# please put your help in in alphabetical order
#
# a string search is done in the command field (case is ignored)
# and all commands matching the asked for command are printed out
#
# the order of the fields in each header is 
#   privilege, command, Description 
# 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/ANNOUNCE [0-9] <pattern>^Set an 'accept' filter line for announce
Create an 'accept this announce' line for a filter. 

An accept filter line means that if the announce matches this filter it is
passed onto the user. See HELP FILTERS for more info. Please read this
to understand how filters work - it will save a lot of grief later on.

You can use any of the following things in this line:-

  info <string>            eg: iota or qsl
  by <prefixes>            eg: G,M,2         
  origin <prefixes>
  origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
  origin_itu <numbers>
  origin_zone <numbers>
  by_dxcc <numbers>
  by_itu <numbers>
  by_zone <numbers>
  channel <prefixes>
  wx 1                     filter WX announces
  dest <prefixes>          eg: 6MUK,WDX      (distros)

some examples:-

  acc/ann dest 6MUK
  acc/ann 2 by_zone 14,15,16
  (this could be all on one line: acc/ann dest 6MUK or by_zone 14,15,16)
or
  acc/ann by G,M,2 

You can use the tag 'all' to accept everything eg:

  acc/ann all

but this probably for advanced users...

=== 8^ACCEPT/ANNOUNCE <call> [input] [0-9] <pattern>^Announce filter sysop version
This version allows a sysop to set a filter for a callsign as well as the
default for nodes and users eg:-

  accept/ann by G,M,2
  accept/ann input node_default by G,M,2
  accept/ann user_default by G,M,2

=== 0^ACCEPT/SPOTS [0-9] <pattern>^Set an 'accept' filter line for spots
Create an 'accept this spot' line for a filter. 

An accept filter line means that if the spot matches this filter it is
passed onto the user. See HELP FILTERS for more info. Please read this
to understand how filters work - it will save a lot of grief later on.

You can use any of the following things in this line:-

  freq <range>           eg: 0/30000 or hf or hf/cw or 6m,4m,2m
  call <prefixes>        eg: G,PA,HB9
  info <string>          eg: iota or qsl
  by <prefixes>            
  call_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
  call_itu <numbers>
  call_zone <numbers>
  by_dxcc <numbers>
  by_itu <numbers>
  by_zone <numbers>
  origin <prefixes>
  channel <prefixes>

For frequencies, you can use any of the band names defined in
SHOW/BANDS and you can use a subband name like: cw, rtty, data, ssb -
thus: hf/ssb. You can also just have a simple range like: 0/30000 -
this is more efficient than saying simply: freq HF (but don't get
too hung up about that)

some examples:-

  acc/spot 1 freq hf/cw
  acc/spot 2 freq vhf and (by_zone 14,15,16 or call_zone 14,15,16)

You can use the tag 'all' to accept everything, eg:

  ann/spot 3 all

but this probably for advanced users...

=== 8^ACCEPT/SPOTS <call> [input] [0-9] <pattern>^Spot filter sysop version
This version allows a sysop to set a filter for a callsign as well as the
default for nodes and users eg:-

  accept/spot db0sue-7 1 by_zone 14,15,16
  accept/spot node_default all
  set/hops node_default 10

  accept/spot user_default by G,M,2

=== 0^ANNOUNCE <text>^Send an announcement to LOCAL users only
<text> is the text of the announcement you wish to broadcast 

=== 0^ANNOUNCE FULL <text>^Send an announcement cluster wide
This will send your announcement cluster wide

=== 5^ANNOUNCE SYSOP <text>^Send an announcement to Sysops only

=== 0^APROPOS <string>^Search help database for <string>
Search the help database for <string> (it isn't case sensitive), and print
the names of all the commands that may be relevant.

=== 0^BYE^Exit from the cluster
This will disconnect you from the cluster

=== 5^CATCHUP <node call> All|[<msgno> ...]^Mark a message as sent
=== 5^UNCATCHUP <node call> All|[msgno> ...]^Unmark a message as sent
When you send messages the fact that you have forwarded it to another node 
is remembered so that it isn't sent again. When you have a new partner
node and you add their callsign to your /spider/msg/forward.pl file, all
outstanding non-private messages will be forwarded to them. This may well
be ALL the non-private messages. You can prevent this by using these 
commmands:-

  catchup GB7DJK all
  catchup GB7DJK 300 301 302 303 500-510
        
and to undo what you have just done:-
  
  uncatchup GB7DJK all
  uncatchup GB7DJK 300 301 302 303 500-510

which will arrange for them to be forward candidates again.

Order is not important.

=== 0^CLEAR/SPOTS [1|all]^Clear a spot filter line
This command allows you to clear (remove) a line in a spot filter or to 
remove the whole filter.

If you have a filter:-

  acc/spot 1 freq hf/cw
  acc/spot 2 freq vhf and (by_zone 14,15,16 or call_zone 14,15,16)

and you say:-

  clear/spot 1

you will be left with:-

  acc/spot 2 freq vhf and (by_zone 14,15,16 or call_zone 14,15,16)

If you do:

  clear/spot all

the filter will be completely removed.

=== 5^CONNECT <callsign>^Start a connection to another DX Cluster
Start a connection process that will culminate in a new connection to the
DX cluster <callsign>. This process creates a new 'client' process which will
use the script in /spider/connect/<callsign> to effect the 'chat' exchange
necessary to traverse the network(s) to logon to the cluster <callsign>.

=== 0^DBAVAIL^Show a list of all the Databases in the system
Title says it all really, this command lists all the databases defined
in the system. It is also aliased to SHOW/COMMAND.

=== 9^DBCREATE <name>^Create a database entry
=== 9^DBCREATE <name> chain <name> [<name>..]^Create a chained database entry
=== 9^DBCREATE <name> remote <node>^Create a remote database entry
DBCREATE allows you to define a database in the system. It doesn't actually
create anything, just defines it.

The databases that are created are simple DB_File hash databases, they are 
therefore already 'indexed'.

You can define a local database with the first form of the command eg:

  DBCREATE oblast

You can also chain databases with the addition of the 'chain' keyword. 
This will search each database one after the other. A typical example 
is:

  DBCREATE sdx_qsl chain sql_ad

No checking is done to see if the any of the chained databases exist, in
fact it is usually better to do the above staement first then do each of
the chained databases.

Databases can exist offsite. To define a database that lives on another 
node do:

  DBCREATE buckmaster remote gb7dxc

Remote databases cannot be chained; however, the last database in a 
a chain can be a remote database eg:

  DBCREATE qsl chain gb7dxc

To see what databases have been defined do:

  DBAVAIL (or it will have been aliased to SHOW/COMMAND)

It would be normal for you to add an entry into your local Aliases file
to allow people to use the 'SHOW/<dbname>' style syntax. So you would
need to add a line like:-

  's' => [
    ..
    ..
    '^sh\w*/buc', 'dbshow buckmaster', 'dbshow',
    ..
    ..
   ],

to allow 
 
  SH/BUCK g1tlh

to work as they may be used to.

See DBIMPORT for the importing of existing AK1A format data to databases.
See DBSHOW for generic database enquiry
 
=== 9^DBIMPORT <dbname> <filename>^Import AK1A data into a database
If you want to import or update data in bulk to a database you can use
this command. It will either create or update entries into an existing
database. For example:-

  DBIMPORT oblast /tmp/OBLAST.FUL

will import the standard OBLAST database that comes with AK1A into the
oblast database held locally.

=== 9^DBREMOVE <dbname>^Delete a database
DBREMOVE will completely remove a database entry and also delete any data
file that is associated with it. 

There is no warning, no comeback, no safety net. 

For example:

  DBREMOVE oblast 

will remove the oblast database from the system and it will also remove
the associated datafile.

I repeat:

There is no warning, no comeback, no safety net.
 
You have been warned.

=== 0^DBSHOW <dbname> <key>^Display an entry, if it exists, in a database
This is the generic user interface to the database to the database system.
It is expected that the sysop will add an entry to the local Aliases file
so that users can use the more familiar AK1A style of enquiry such as:

  SH/BUCK G1TLH

but if he hasn't and the database really does exist (use DBAVAIL or
SHOW/COMMAND to find out) you can do the same thing with:

  DBSHOW buck G1TLH

=== 9^DEBUG^Set the cluster program into debug mode
Executing this command will only have an effect if you are running the cluster
in debug mode i.e.

        perl -d cluster.pl

It will interrupt the cluster just after the debug command has finished.
=== 0^DIRECTORY^List messages 
=== 0^DIRECTORY ALL^List all messages
=== 0^DIRECTORY OWN^List your own messages
=== 0^DIRECTORY NEW^List all new messages
=== 0^DIRECTORY TO <call>^List all messages to <call>
=== 0^DIRECTORY FROM <call>^List all messages from <call>
=== 0^DIRECTORY SUBJECT <string>^List all messages with <string> in subject
=== 0^DIRECTORY <nn>^List last <nn> messages
=== 0^DIRECTORY <from>-<to>^List messages <from> message <to> message 
List the messages in the messages directory.

If there is a 'p' one space after the message number then it is a 
personal message. If there is a '-' between the message number and the
'p' then this indicates that the message has been read.

You can use shell escape characters such as '*' and '?' in the <call>
fields.

You can combine some of the various directory commands together eg:-

   DIR TO G1TLH 5
or 
   DIR SUBJECT IOTA 200-250

You can abbreviate all the commands to one letter and use ak1a syntax:-

   DIR/T G1* 10
   DIR/S QSL 10-100 5

=== 5^DIRECTORY-^
Sysops can see all users' messages.

=== 8^DISCONNECT <call> [<call> ...]^Disconnect a user or cluster
Disconnect any <call> connected locally

=== 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
enter the <freq> and the <call> either way round. 

   DX FR0G 144.600
   DX 144.600 FR0G
   DX 144600 FR0G 

will all give the same result. You can add some remarks to the end
of the command and they will be added to the spot.

   DX FR0G 144600 this is a test

You can credit someone else by saying:-

   DX by G1TLH FR0G 144.600 he isn't on the cluster

The <freq> is compared against the available bands set up in the 
cluster.  See SHOW/BANDS for more information.

=== 9^EXPORT <msgno> <filename>^Export a message to a file
Export a message to a file. This command can only be executed on a local
console with a fully privileged user. The file produced will be in a form
ready to be imported back into the cluster by placing it in the import 
directory (/spider/msg/import).

This command cannot overwrite an existing file. This is to provide some 
measure of security. Any files written will owned by the same user as the 
main cluster, otherwise you can put the new files anywhere the cluster can
access. For example:-

  EXPORT 2345 /tmp/a

=== 9^EXPORT_USERS [<filename>]^Export the users database to ascii
Export the users database to a file in ascii format. If no filename
is given then it will export the file to /spider/data/user_asc.

If the file already exists it will be renamed to <filename>.o. In fact
up to 5 generations of the file can be kept each one with an extra 'o' on the
suffix. 

BE WARNED: this will write to any file you have write access to. No check is
made on the filename (if any) that you specify.

=== 0^FILTERING...^Filtering things in DXSpider
There are a number of things you can filter in the DXSpider system. They
all use the same general mechanism.

In general terms you can create a 'reject' or an 'accept' filter which
can have up to 10 lines in it. You do this using, for example:-
 
  accept/spots .....
  reject/spots .....

where ..... are the specific commands for that type of filter. There
are filters for spots, wwv, announce, wcy and (for sysops)
connects. See each different accept or reject command reference for
more details.

There is also a command to clear out one or more lines in a filter and
one to show you what you have set. They are:-

  clear/spots 1
  clear/spots all

and 
  
  show/filter

There is clear/xxxx command for each type of filter.

For now we are going to use spots for the examples, but you can apply
the principles to all types of filter.

There are two main types of filter 'accept' or 'reject'; which you use
depends entirely on how you look at the world and what is least
writing to achieve what you want. Each filter has 10 lines (of any
length) which are tried in order. If a line matches then the action
you have specified is taken (ie reject means ignore it and accept
means gimme it).

The important thing to remember is that if you specify a 'reject'
filter (all the lines in it say 'reject/spots' (for instance) then if
a spot comes in that doesn't match any of the lines then you will get
it BUT if you specify an 'accept' filter then any spots that don't
match are dumped. For example if I have a one line accept filter:-

  accept/spots freq vhf and (by_zone 14,15,16 or call_zone 14,15,16)

then automatically you will ONLY get VHF spots from or to CQ zones 14
15 and 16.  If you set a reject filter like:

  reject/spots freq hf/cw

Then you will get everything EXCEPT HF CW spots, If you am interested in IOTA
and will work it even on CW then you could say:-

  reject/spots freq hf/cw and not info iota

But in that case you might only be interested in iota and say:-

  accept/spots not freq hf/cw or info iota

which is exactly the same. You should choose one or the other until
you are confortable with the way it works. Yes, you can mix them
(actually you can have an accept AND a reject on the same line) but
don't try this at home until you can analyse the results that you get
without ringing up the sysop for help.

You can arrange your filter lines into logical units, either for your
own understanding or simply convenience. I have one set frequently:-

  reject/spots 1 freq/cw
  reject/spots 2 freq 50000/1400000 not (by_zone 14,15,16 or call_zone 14,15,16)  

What this does is to ignore all HF CW spots (being a class B I can't
read any CW and couldn't possibly be interested in HF :-) and also
rejects any spots on VHF which don't either originate or spot someone
in Europe.

This is an exmaple where you would use the line number (1 and 2 in
this case), if you leave the digit out, the system assumes '1'. Digits
'0'-'9' are available.

You can leave the word 'and' out if you want, it is implied. You can
use any number of brackets to make the 'expression' as you want
it. There are things called precedence rules working here which mean
that you will NEED brackets in a situation like line 2 because,
without it, will assume:-

  (freq 50000/1400000 and by_zone 14,15,16) or call_zone 14,15,16 

annoying, but that is the way it is. If you use OR - use
brackets. Whilst we are here CASE is not important. 'And BY_Zone' is
just 'and by_zone'.

If you want to alter your filter you can just redefine one or more
lines of it or clear out one line. For example:-

  reject/spots 1 freq/ssb

or 

  clear/spots 1

To remove the filter in its entirty:-

  clear/spots all

ADVANCED USERS:-

Once you are happy with the results you get, you may like to experiment. 

my example that filters hf/cw spots and accepts vhf/uhf spots from EU
can be written with a mixed filter, eg:

  rej/spot freq hf/cw
  acc/spot freq 0/30000
  acc/spot 2 freq 50000/1400000 and (by_zone 14,15,16 or call_zone 14,15,16)

each filter slot actually has a 'reject' slot and an 'accept'
slot. The reject slot is executed BEFORE the accept slot.

It was mentioned earlier that after a reject test that doesn't match,
the default for following tests is 'accept', the reverse is true for
'accept'. 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
thru everything else on HF.

The next filter line lets through just VHF/UHF spots from EU.

=== 1^FORWARD/OPERNAM <call>^Send out information on this <call> to all clusters
This command sends out any information held in the user file which can 
be broadcast in PC41 protocol packets. This information is Name, QTH, Location
and Homenode. PC41s are only sent for the information that is available.
 
=== 0^HELP^The HELP Command
HELP is available for a number of commands. The syntax is:-

  HELP <cmd>
  
Where <cmd> is the name of the command you want help on.

All commands can be abbreviated, so SHOW/DX can be abbreviated
to SH/DX, ANNOUNCE can be shortened to AN and so on.

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.

=== 5^INIT <node>^Re-initialise a link to an AK1A compatible node
This command attempts to re-initialise a link to a (usually) AK1A node
that has got confused, usually by a protocol loop of some kind. It may
work - but you usually will be better off simply disconnecting it (or
better, if it is a real AK1A node, doing an RCMD <node> DISC/F <your
node>).

Best of luck - you will need it.
  
=== 0^KILL <msgno> [<msgno..]^Delete a message from the local system
Delete a message from the local system. You will only be able to
delete messages that you have originated or been sent (unless you are
the sysop).

=== 5^KILL FULL <msgno> [<msgno..]^Delete a message from the whole cluster
Delete a message (usually a 'bulletin') from the whole cluster system. 

This uses the subject field, so any messages that have exactly the
same subject will be deleted. Beware!

=== 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.

=== 9^LOAD/ALIASES^Reload the command alias table
Reload the /spider/cmd/Aliases file after you have editted it. You
will need to do this if you change this file whilst the cluster is
running in order for the changes to take effect.

=== 9^LOAD/BANDS^Reload the band limits table
Reload the /spider/data/bands.pl file if you have changed it manually whilst
the cluster is running. 

=== 9^LOAD/BADDX^Reload the bad DX table
Reload the /spider/data/baddx.pl file if you have changed it manually whilst
the cluster is running. This table contains the DX Calls that, if spotted, 
will not be passed on. FR0G and TEST are classic examples.

=== 9^LOAD/BADMSG^Reload the bad msg table
Reload the /spider/msg/badmsg.pl file if you have changed it manually whilst
the cluster is running. This table contains a number of perl regular 
expressions which are searched for in the fields targetted of each message. 
If any of them match then that message is immediately deleted on receipt. 

=== 9^LOAD/BADWORDS^Reload the bad words table
Reload the /spider/data/badwords file if you have changed it manually whilst
the cluster is running. This file contains a list of words which, if found
on certain text portions of PC protocol, will cause those protocol frames
to be rejected. It will all put out a message if any of these words are
used on the announce, dx and talk commands. The words can be one or 
more on a line, lines starting with '#' are ignored.

=== 9^LOAD/CMD_CACHE^Reload the automatic command cache
Normally, if you change a command file in the cmd or local_cmd tree it
will automatially be picked up by the cluster program. Sometimes it
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.

=== 9^LOAD/FORWARD^Reload the msg forwarding routing table
Reload the /spider/msg/forward.pl file if you have changed it
manually whilst the cluster is running.

=== 9^LOAD/MESSAGES^Reload the system messages file
If you change the /spider/perl/Messages file (usually whilst
fiddling/writing new commands) you can have them take effect during a
cluster session by executing this command. You need to do this if get
something like :-

unknown message 'xxxx' in lang 'en'

=== 9^LOAD/PREFIXES^Reload the prefix table
Reload the /spider/data/prefix_data.pl file if you have changed it
manually whilst the cluster is running.

=== 5^MERGE <node> [<no spots>/<no wwv>]^Ask for the latest spots and WWV 
MERGE allows you to bring your spot and wwv database up to date. By default
it will request the last 10 spots and 5 WWVs from the node you select. The 
node must be connected locally.

You can request any number of spots or wwv and although they will be appended
to your databases they will not duplicate any that have recently been added 
(the last 2 days for spots and last month for WWV data).

=== 9^MSG <cmd> <msgno> [data ... ]^Alter various message parameters
Alter message parameters like To, From, Subject, whether private or bulletin
or return receipt (RR) is required or whether to keep this message from timing
out.

  MSG TO <msgno> <call>     - change TO callsign to <call>
  MSG FRom <msgno> <call>   - change FROM callsign to <call>
  MSG PRrivate <msgno>      - set private flag
  MSG NOPRrivate <msgno>    - unset private flag
  MSG RR <msgno>            - set RR flag
  MSG NORR <msgno>          - unset RR flag
  MSG KEep <msgno>          - set the keep flag (message won't be deleted ever)
  MSG NOKEep <msgno>        - unset the keep flag
  MSG SUbject <msgno> <new> - change the subject to <new>
  MSG WAittime <msgno>      - remove any waitting time for this message
  MSG NOREad <msgno>        - mark message as unread
  MSG REad <msgno>          - mark message as read
  MSG QUeue                 - queue any outstanding bulletins
  MSG QUeue 1               - queue any outstanding private messages

You can look at the status of a message by using:-

  STAT/MSG <msgno>      

This will display more information on the message than DIR does.
   
=== 8^PC <call> <text>^Send text (eg PC Protocol) to <call>
Send some arbitrary text to a locally connected callsign. No
processing is done on the text. This command allows you to send PC
Protocol to unstick things if problems arise (messages get stuck
etc). eg:-

   pc gb7djk PC33^GB7TLH^GB7DJK^400^
or 
   pc G1TLH Try doing that properly!!!

=== 1^PING <node>^Send a ping command to another cluster
This command is used to estimate the quality of the link to another cluster. 
The time returned is the length of time taken for a PC51 to go to another 
cluster and be returned.

=== 0^KILL <msgno> [<msgno> ...]^Remove or erase a message from the system
You can get rid of any message to or originating from your callsign using 
this command. You can remove more than one message at a time.

=== 5^KILL <from>-<to>^Remove a range of messages from the system
=== 5^KILL FROM <call>^Remove all messages from a callsign
=== 5^KILL TO <call>^Remove all messages to a callsign
=== 5^KILL FULL <msgno> [<msgno]^Remove a message from the entire cluster
Remove this message from the entire cluster system as well as your node.

=== 5^KILL^
As a sysop you can kill any message on the system.

=== 8^PC <call> <text>^Send arbitrary text to a connected callsign
Send any text you like to the callsign requested. This is used mainly to send
PC protocol to connected nodes either for testing or to unstick things. 

You can also use in the same way as a talk command to a connected user but
without any processing, added of "from <blah> to <blah" or whatever.
 
=== 1^PING <node call>^Find out the delays an a circuit to another node
This command will enable sysops to determine the speed of an inter-cluster
node. 

Any visible cluster node can be PINGed.

=== 1^RCMD <node call> <cmd>^Send a command to another DX Cluster
This command allows you to send nearly any command to another DX Cluster
node that is connected to the system. 

Whether you get any output is dependant on a) whether the other system knows
that the node callsign of this cluster is in fact a node b) whether the
other system is allowing RCMDs from this node and c) whether you have
permission to send this command at all.

=== 0^READ^Read the next unread personal message addressed to you
=== 0^READ <msgno>^Read the specified message
You can read any messages that are sent as 'non-personal' and also any
message either sent by or sent to your callsign.

=== 5^READ-^
As a sysop you may read any message on the system

=== 0^REJECT/ANNOUNCE [0-9] <pattern>^Set an 'reject' filter line for announce
Create an 'reject this announce' line for a filter. 

An reject filter line means that if the announce matches this filter it is
passed onto the user. See HELP FILTERS for more info. Please read this
to understand how filters work - it will save a lot of grief later on.

You can use any of the following things in this line:-

  info <string>            eg: iota or qsl
  by <prefixes>            eg: G,M,2         
  origin <prefixes>
  origin_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
  origin_itu <numbers>
  origin_zone <numbers>
  by_dxcc <numbers>
  by_itu <numbers>
  by_zone <numbers>
  channel <prefixes>
  wx 1                     filter WX announces
  dest <prefixes>          eg: 6MUK,WDX      (distros)

some examples:-

  rej/ann by_zone 14,15,16 and not by G,M,2
 
You can use the tag 'all' to reject everything eg:

  rej/ann all

but this probably for advanced users...

=== 8^REJECT/ANNOUNCE <call> [input] [0-9] <pattern>^Announce filter sysop version
This version allows a sysop to set a filter for a callsign as well as the
default for nodes and users eg:-

  reject/ann by G,M,2
  reject/ann input node_default by G,M,2
  reject/ann user_default by G,M,2

=== 0^REJECT/SPOTS [0-9] <pattern>^Set an 'reject' filter line for spots
Create an 'reject this spot' line for a filter. 

An reject filter line means that if the spot matches this filter it is
dumped (not passed on). See HELP FILTERS for more info. Please read this
to understand how filters work - it will save a lot of grief later on.

You can use any of the following things in this line:-

  freq <range>           eg: 0/30000 or hf or hf/cw or 6m,4m,2m
  call <prefixes>        eg: G,PA,HB9
  info <string>          eg: iota or qsl
  by <prefixes>            
  call_dxcc <numbers>    eg: 61,62 (from eg: sh/pre G)
  call_itu <numbers>
  call_zone <numbers>
  by_dxcc <numbers>
  by_itu <numbers>
  by_zone <numbers>
  origin <prefixes>
  channel <prefixes>

For frequencies, you can use any of the band names defined in
SHOW/BANDS and you can use a subband name like: cw, rtty, data, ssb -
thus: hf/ssb. You can also just have a simple range like: 0/30000 -
this is more efficient than saying simply: freq HF (but don't get
too hung up about that)

some examples:-

  rej/spot 1 freq hf
  rej/spot 2 freq vhf and not (by_zone 14,15,16 or call_zone 14,15,16)

You can use the tag 'all' to reject everything eg:

  rej/spot 3 all

but this probably for advanced users...

=== 8^REJECT/SPOTS <call> [input] [0-9] <pattern>^Spot filter sysop version
This version allows a sysop to set a filter for a callsign as well as the
default for nodes and users eg:-

  reject/spot db0sue-7 1 by_zone 14,15,16
  reject/spot node_default all
  set/hops node_default 10

  reject/spot user_default by G,M,2

=== 0^REPLY^Reply (privately) to the last message that you have read
=== 0^REPLY <msgno>^Reply (privately) to the specified message
=== 0^REPLY B <msgno>^Reply as a Bulletin to the specified message
=== 0^REPLY NOPrivate <msgno>^Reply as a Bulletin to the specified message
=== 0^REPLY RR <msgno>^Reply to the specified message with read receipt
You can reply to a message and the subject will automatically have
"Re:" inserted in front of it, if it isn't already present.

You can also use all the extra qualifiers such as RR, PRIVATE, 
NOPRIVATE, B that you can use with the SEND command (see SEND
for further details)

=== 0^SEND <call> [<call> ...]^Send a message to one or more callsigns
=== 0^SEND RR <call>^Send a message and ask for a read receipt
=== 0^SEND COPY <msgno> <call>^Send a copy of a  message to someone
=== 0^SEND PRIVATE <call>^Send a personal message
=== 0^SEND NOPRIVATE <call>^Send a message to all stations
All the SEND commands will create a message which will be sent either to
an individual callsign or to one of the 'bulletin' addresses. 

SEND <call> on its own acts as though you had typed SEND PRIVATE, that is
it will mark the message as personal and send it to the cluster node that
that callsign is connected to.

You can have more than one callsign in all of the SEND commands.

You can have multiple qualifiers so that you can have for example:-

  SEND RR COPY 123 PRIVATE G1TLH G0RDI

which should send a copy of message 123 to G1TLH and G0RDI and you will
receive a read receipt when they have read the message.

SB is an alias for SEND NOPRIVATE (or send a bulletin in BBS speak)
SP is an alias for SEND PRIVATE

=== 0^SET/ADDRESS <your address>^Record your postal address

=== 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

=== 0^SET/BEEP^Add a beep to DX and other messages on your terminal
=== 0^UNSET/BEEP^Stop beeps for DX and other messages on your terminal

=== 5^SET/CLX <call> [<call>..]^Make the callsign an CLX node

=== 9^SET/DEBUG <name>^Add a debug level to the debug set
=== 9^UNSET/DEBUG <name>^Remove a debug level from the debug set

=== 0^SET/DX^Allow DX messages to come out on your terminal
=== 0^UNSET/DX^Stop DX messages coming out on your terminal

=== 0^SET/DXGRID^Allow Grid Squares on the end of DX announcements
=== 0^UNSET/DXGRID^Stop Grid Squares on the end of DX announcements
A standard feature which is enabled in version 1.43 and above is 
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.

=== 5^SET/DXNET <call> [<call>..]^Make the callsign an DXNet node

=== 0^SET/ECHO^Make the cluster echo your input
=== 0^UNSET/ECHO^Stop the cluster echoing your input
If you are connected via a telnet session, different implimentations
of telnet handle echo differently depending on whether you are 
connected via port 23 or some other port. You can use this command
to change the setting appropriately. 

The setting is stored in your user profile.

YOU DO NOT NEED TO USE THIS COMMAND IF YOU ARE CONNECTED VIA AX25.

=== 0^SET/HERE^Tell the system you are present at your terminal
=== 0^UNSET/HERE^Tell the system you are absent from your terminal

=== 0^SET/HOMENODE <node> ^Set your normal cluster callsign
Tell the cluster system where you normally connect to. Any Messages sent
to you will normally find their way there should you not be connected.
eg:-
  SET/HOMENODE gb7djk

=== 8^SET/HOPS <call> ann|spots|wwv|wcy <n>^Set hop count  
Set the hop count for a particular type of broadcast for a node.

This command allows you to set up special hop counts for a node 
for currently: announce, spots, wwv and wcy broadcasts.

eg:
  set/hops gb7djk ann 10
  set/hops gb7mbc spots 20

Set SHOW/HOPS for information on what is already set. This command
creates a filter and works in conjunction with the filter system. 

=== 9^SET/ISOLATE^Isolate a node from the rest of the network
Connect a node to your system in such a way that you are a full protocol
member of its network and can see all spots on it, but nothing either leaks
out from it nor goes back into from the rest of the nodes connected to you.

You can potentially connect several nodes in this way.
 
=== 9^UNSET/ISOLATE^Stop Isolation of a node from the rest of the network
Remove isolation from a node - SET/ISOLATE

=== 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) and nl (dutch).

=== 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
what your latitude and longitude is. If you have not yet done a SET/QRA
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

=== 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/NAME <your name>^Set your name
Tell the system what your name is eg:-
  SET/NAME Dirk

=== 5^SET/NODE <call> [<call>..]^Make the callsign an AK1A cluster
Tell the system that the call(s) are to be treated as AK1A cluster and
fed PC Protocol rather normal user commands.

=== 8^SET/OBSCOUNT <count> <nodecall>^Set the 'pump-up' obscelence counter 
From 1.35 onwards neighbouring nodes are pinged at regular intervals (see
SET/PINGINTERVAL), usually 300 seconds or 5 minutes. There is a 'pump-up'
counter which is decremented on every outgoing ping and then reset to
the 'obscount' value on every incoming ping. The default value of this
parameter is 2. 

What this means is that a neighbouring node will be pinged twice at 
(default) 300 second intervals and if no reply has been heard just before
what would be the third attempt, that node is disconnected.

If a ping is heard then the obscount is reset to the full value. Using
default values, if a node has not responded to a ping within 15 minutes,
it is disconnected.

=== 0^SET/PAGE <lines per page>^Set the lines per page
Tell the system how many lines you wish on a page when the number of line
of output from a command is more than this. The default is 20. Setting it
explicitly to 0 will disable paging. 
  SET/PAGE 30
  SET/PAGE 0

The setting is stored in your user profile.

=== 9^SET/PINGINTERVAL <time> <nodecall>^Set ping time to neighbouring nodes 
As from release 1.35 all neighbouring nodes are pinged at regular intervals
in order to determine the rolling quality of the link and, in future, to
affect routing decisions. The default interval is 300 secs or 5 minutes.

You can use this command to set a different interval. Please don't. 

But if you do the value you enter is treated as minutes up 60 and seconds
for numbers greater than that.

This is used also to help determine when a link is down at the far end
(as certain cluster software doesn't always notice), see SET/OBSCOUNT
for more information.

=== 9^SET/PRIVILEGE <n> <call> [<call..]^Set privilege level on a call
Set the privilege level on a callsign. The privilege levels that pertain
to commands are as default:-
  0 - normal user
  1 - allow remote nodes normal user RCMDs
  5 - various privileged commands (including shutdown, but not disc-
      connect), the normal level for another node.
  8 - more privileged commands (including disconnect)
  9 - local sysop privilege. DO NOT SET ANY REMOTE USER OR NODE TO THIS
      LEVEL.
If you are a sysop and you come in as a normal user on a remote connection
your privilege will automatically be set to 0.

=== 9^SET/PASSWORD <callsign> <string>^Set a users password
The password for a user can only be set by a full sysop. The string
can contain any characters but any spaces are removed (you can type in
spaces - but they won't appear in the password). You can see the
result with STAT/USER.

=== 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.

=== 9^SET/SYS_QRA <locator>^Set your cluster QRA locator
=== 0^SET/QRA <locator>^Set your QRA locator
Tell the system what your QRA (or Maidenhead) locator is. If you have not
done a SET/LOCATION then your latitude and longitude will be set roughly
correctly (assuming your locator is correct ;-). For example:-
  SET/QRA JO02LQ

=== 0^SET/QTH <your qth>^Set your QTH
Tell the system where you are. For example:-
  SET/QTH East Dereham, Norfolk

=== 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/WCY^Allow WCY messages to come out on your terminal
=== 0^UNSET/WCY^Stop WCY messages coming out on your terminal

=== 0^SET/WWV^Allow WWV messages to come out on your terminal
=== 0^UNSET/WWV^Stop WWV 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/CALL <callsign>^Show any callbook details on a callsign
This command queries an international callbook server on the internet
and returns any information available for that callsign. 

=== 0^SHOW/DATE [<prefix>|<callsign>]^Show the local time 
This is very nearly the same as SHOW/TIME, the only difference the format
of the date string if no arguments are given.

If no prefixes or callsigns are given then this command returns the local
time and UTC as the computer has it right now. If you give some prefixes
then it will show UTC and UTC + the local offset (not including DST) at
the prefixes or callsigns that you specify.

=== 0^SHOW/DX^Interrogate the spot database
If you just type SHOW/DX you will get the last so many spots
(sysop configurable, but usually 10).
   
In addition you can add any number of these commands in very nearly
any order to the basic SHOW/DX command, they are:-
   
on <band>       - eg 160m 20m 2m 23cm 6mm
on <region>     - eg hf vhf uhf shf      (see SHOW/BANDS)
   
<number>        - the number of spots you want
<from>-<to>     - <from> spot no <to> spot no in the selected list
   
<prefix>        - for a spotted callsign beginning with <prefix>
*<suffix>       - for a spotted callsign ending in <suffix>
*<string>*      - for a spotted callsign containing <string>
   
day <number>    - starting <number> days ago
day <from>-<to> - <from> days <to> days ago
   
info <text>     - any spots containing <text> in the info or remarks
   
by <call>       - any spots spotted by <call> (spotter <call> is the 
                  same).

qsl             - this automatically looks for any qsl info on the call
                  held in the spot database.

iota [<iota>]   - If the iota island number is missing it will look for
                  the string iota and anything which looks like an iota
                  island number. If you specify then it will look for  
                  that island.

qra [<locator>] - this will look for the specific locator if you specify
                  one or else anything that looks like a locator.
   
e.g. 
   
   SH/DX 9m0
   SH/DX on 20m info iota
   SH/DX 9a on vhf day 30
   SH/DX rf1p qsl
   SH/DX iota 
   SH/DX iota eu-064
   SH/DX qra jn86
  
=== 0^SHOW/DXCC <prefix>^Interrogate the spot database by country
This command takes the <prefix> (which can be a full or partial 
callsign if desired), looks up which internal country number it is
and then displays all the spots as per SH/DX for that country.
   
The options for SHOW/DX also apply to this command.   
e.g. 
   
   SH/DXCC G
   SH/DXCC W on 20m info iota

=== 0^SHOW/FILES [<filearea> [<string>]]^List the contents of a filearea
SHOW/FILES on its own will show you a list of the various fileareas
available on the system. To see the contents of a particular file
area type:-
   SH/FILES <filearea>
where <filearea> is the name of the filearea you want to see the 
contents of.

You can also use shell globbing characters like '*' and '?' in a
string to see a selection of files in a filearea eg:-
   SH/FILES bulletins arld*

See also TYPE - to see the contents of a file.

=== 0^SHOW/FILTER^Show the contents of all the filters you have set
Show the contents of all the filters that are set. This command displays
all the filters set - for all the various categories.

=== 8^SHOW/HOPS <call> [ann|spots|wcy|wwv]^Show the hop counts for a node
This command shows the hop counts set up for a node. You can specify
which category you want to see. If you leave the category out then 
all the categories will be listed.
 
=== 1^SHOW/ISOLATE^Show list of ISOLATED nodes

=== 9^SHOW/LOCKOUT^Show the list of locked out or excluded callsigns

=== 0^SHOW/MOON [<prefix>|<callsign>]^Show Moon rise and set times
Show the Moon rise and set times for a (list of) prefixes or callsigns, 
together with the azimuth and elevation of the sun currently at those
locations.

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.

In addition, it will show the gain or loss dB relative to the nominal 
distance of 385,000Km due to the ellipsoidal nature of the orbit.

If all else fails it will show the Moonrise and set times for the node
that you are connected to. 

For example:-

  SH/MOON
  SH/MOON G1TLH W5UN

=== 0^SHOW/MUF <prefix> [<hours>][long]^Show the likely propagation to a prefix
This command allow you to estimate the likelihood of you contacting
a station with the prefix you have specified. The output assumes a modest
power of 20dBW and receiver sensitivity of -123dBm (about 0.15muV/10dB SINAD)

The result predicts the most likely operating frequencies and signal
levels for high frequency (shortwave) radio propagation paths on
specified days of the year and hours of the day. It is most useful for
paths between 250 km and 6000 km, but can be used with reduced accuracy
for paths shorter or longer than this.

The command uses a routine MINIMUF 3.5 developed by the U.S. Navy and
used to predict the MUF given the predicted flux, day of the year,
hour of the day and geographic coordinates of the transmitter and
receiver. This routine is reasonably accurate for the purposes here,
with a claimed RMS error of 3.8 MHz, but much smaller and less complex
than the programs used by major shortwave broadcasting organizations,
such as the Voice of America.

The command will display some header information detailing its
assumptions, together with the locations, latitude and longitudes and
bearings. It will then show UTC (UT), local time at the other end
(LT), calculate the MUFs, Sun zenith angle at the midpoint of the path
(Zen) and the likely signal strengths. Then for each frequency for which
the system thinks there is a likelihood of a circuit it prints a value.

The value is currently a likely S meter reading based on the conventional
6dB / S point scale. If the value has a '+' appended it means that it is
1/2 an S point stronger. If the value is preceeded by an 'm' it means that
there is likely to be much fading and by an 's' that the signal is likely
to be noisy.  

By default SHOW/MUF will show the next two hours worth of data. You
can specify anything up to 24 hours worth of data by appending the no of
hours required after the prefix. For example:-

  SH/MUF W

produces:

  RxSens: -123 dBM SFI: 159   R: 193   Month: 10   Day: 21
  Power :   20 dBW    Distance:  6283 km    Delay: 22.4 ms
  Location                       Lat / Long           Azim
  East Dereham, Norfolk          52 41 N 0 57 E         47
  United-States-W                43 0 N 87 54 W        299
  UT LT  MUF Zen  1.8  3.5  7.0 10.1 14.0 18.1 21.0 24.9 28.0 50.0
  18 23 11.5 -35  mS0+ mS2   S3
  19  0 11.2 -41  mS0+ mS2   S3

indicating that you will have weak, fading circuits on top band and 
80m but usable signals on 40m (about S3).

inputing:-

  SH/MUF W 24

will get you the above display, but with the next 24 hours worth of
propagation data.

  SH/MUF W L 24
  SH/MUF W 24 Long

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.

=== 1^SHOW/NODE [<callsign> ...]^Show the type and version number of nodes
Show the type and version (if connected) of the nodes specified on the
command line. If no callsigns are specified then a sorted list of all
the non-user callsigns known to the system will be displayed.

=== 0^SHOW/PREFIX <callsign>^Interrogate the prefix database 
This command takes the <callsign> (which can be a full or partial 
callsign or a prefix), looks up which internal country number 
it is and then displays all the relevant prefixes for that country
together with the internal country no, the CQ and ITU regions. 

See also SHOW/DXCC

=== 5^SHOW/PROGRAM^Show the locations of all the included program modules
Show the name and location where every program module was load from. This
is useful for checking where you think you have loaded a .pm file from. 

=== 0^SHOW/QRA <locator> [<locator>]^Show distance between locators
=== 0^SHOW/QRA <lat> <long>^Convert latitude and longitude to a locator
This is a multipurpose command that allows you either to calculate the
distance and bearing between two locators or (if only one locator is
given on the command line) the distance and beraing from your station
to the locator. For example:-

SH/QRA IO92QL 
SH/QRA JN06 IN73

The first example will show the distance and bearing to the locator from
yourself, the second example will calculate the distance and bearing from
the first locator to the second. You can use 4 or 6 character locators.

It is also possible to convert a latitude and longitude to a locator by 
using this command with a latitude and longitude as an argument, for
example:-

SH/QRA 52 41 N 0 58 E

=== 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.

If you use this command without a satellite name it will display a list
of all the satellites known currently to the system. 

If you give a name then you can obtain tracking data of all the passes
that start and finish 5 degrees below the horizon. As default it will
give information for the next three hours for every five minute period.

You can alter the number of hours and the step size, within certain 
limits. 

Each pass in a period is separated with a row of '-----' characters

So for example:-

SH/SAT AO-10 
SH/SAT FENGYUN1 12 2

=== 0^SHOW/SUN [<prefix>|<callsign>]^Show sun rise and set times
Show the sun rise and set times for a (list of) prefixes or callsigns, 
together with the azimuth and elevation of the sun currently at those
locations.

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 sunrise and set times for the node
that you are connected to. 

For example:-

  SH/SUN
  SH/SUN G1TLH K9CW ZS

=== 0^SHOW/TIME [<prefix>|<callsign>]^Show the local time 
If no prefixes or callsigns are given then this command returns the local
time and UTC as the computer has it right now. If you give some prefixes
then it will show UTC and UTC + the local offset (not including DST) at
the prefixes or callsigns that you specify.

=== 0^SHOW/WCY^Show last 10 WCY broadcasts
=== 0^SHOW/WCY <n>^Show last <n> WCY broadcasts
Display the most recent WCY information that has been received by the system

=== 0^SHOW/WWV^Show last 10 WWV broadcasts
=== 0^SHOW/WWV <n>^Show last <n> WWV broadcasts
Display the most recent WWV information that has been received by the system

=== 5^SHUTDOWN^Shutdown the cluster
Shutdown the cluster and disconnect all the users 

=== 9^SPOOF <call> <command>^Do a command as though you are another user
This command is provided so that sysops can set a user's parameters without
me having to write a special 'sysop' version for every user command. It
allows you to pretend that you are doing the command as the user you specify.

eg:-

   SPOOF G1TLH set/name Dirk
   SPOOF G1TLH set/qra JO02LQ

=== 5^STAT/DB <dbname>^Show the status of a database
Show the internal status of a database descriptor.

Depending on your privilege level you will see more or less information. 
This command is unlikely to be of much use to anyone other than a sysop.

=== 5^STAT/CHANNEL [<callsign>]^Show the status of a channel on the cluster
Show the internal status of the channel object either for the channel that 
you are on or else for the callsign that you asked for.

Only the fields that are defined (in perl term) will be displayed.

=== 5^STAT/MSG <msgno>^Show the status of a message
This command shows the internal status of a message and includes information
such as to whom it has been forwarded, its size, origin etc etc.

=== 5^STAT/USER [<callsign>]^Show the full status of a user
Shows the full contents of a user record including all the secret flags
and stuff.

Only the fields that are defined (in perl term) will be displayed.

=== 0^SYSOP^Regain your privileges if you login remotely
The system automatically reduces your privilege level to that of a
normal user if you login in remotely. This command allows you to
regain your normal privilege level. It uses the normal system: five
numbers are returned that are indexes into the character array that is
your assigned password (see SET/PASSWORD). The indexes start from
zero.

You are expected to return a string which contains the characters
required in the correct order. You may intersperse those characters
with others to obscure your reply for any watchers. For example (and
these values are for explanation :-):

  password = 012345678901234567890123456789
  > sysop
  22 10 15 17 3
you type:-
 aa2bbbb0ccc5ddd7xxx3n
 or 2 0 5 7 3
 or 20573

They will all match. If there is no password you will still be offered
numbers but nothing will happen when you input a string. Any match is
case sensitive.

=== 0^TALK <call> [<text>]^Send a text message to another station
=== 0^TALK <call> > <node> [<text>]^Send a text message to another station via a node
Send a short message to any other station that is visible on the cluster
system. You can send it to anyone you can see with a SHOW/CONFIGURATION 
command, they don't have to be connected locally.

The second form of TALK is used when other cluster nodes are connected
with restricted information. This usually means that they don't send 
the user information usually associated with logging on and off the cluster.

If you know that G3JNB is likely to be present on GB7TLH, but you can only
see GB7TLH in the SH/C list but with no users, then you would use the
second form of the talk message.

If you want to have a ragchew with someone you can leave the text message
out and the system will go into 'Talk' mode. What this means is that a
short message is sent to the recipient telling them that you are in a
'Talking' frame of mind and then you just type - everything you send will
go to the station that you asked for. 

All the usual announcements, spots and so on will still come out on your
terminal.

If you want to do something (such as send a spot) you preceed the normal 
command with a '/' character, eg:-

   /DX 14001 G1TLH What's a B class licensee doing on 20m CW?
   /HELP talk

To leave talk mode type:
   
   /EX

=== 0^TYPE <filearea>/<name>^Look at the contents of a file in one of the fileareas
Type out the contents of a file in a filearea. So, for example, in 
filearea 'bulletins' you want to look at file 'arld051' you would 
enter:-
   TYPE bulletins/arld051

See also SHOW/FILES to see what fileareas are available and a 
list of content.

=== 0^WHO^Show who is physically connected
This is a quick listing that shows which callsigns are connected and
what sort of connection they have

=== 0^WX <text>^Send a weather message to local users
=== 0^WX FULL <text>^Send a weather message to all cluster users
=== 5^WX SYSOP <text>^Send a weather message to other clusters only
Weather messages can sometimes be useful if you are experiencing an extreme
that may indicate enhanced conditions