Various documentation changes
[spider.git] / cmd / Commands_en.hlp
index ac268bdc4c00b65a21f40dacacb50c3756ace0b9..463d55e8800766b2d9716de66c3ff70accd963bd 100644 (file)
@@ -65,6 +65,7 @@ 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
+  on <range>             same as 'freq'
   call <prefixes>        eg: G,PA,HB9
   info <string>          eg: iota or qsl
   by <prefixes>            
@@ -85,12 +86,12 @@ 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)
+  acc/spot 1 on hf/cw
+  acc/spot 2 on 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
+  acc/spot 3 all
 
 but this probably for advanced users...
 
@@ -104,6 +105,67 @@ default for nodes and users eg:-
 
   accept/spot user_default by G,M,2
 
+=== 0^ACCEPT/WCY [0-9] <pattern>^set an 'accept' WCY filter
+It is unlikely that you will want to do this, but if you do then you can
+filter on the following fields:-
+
+  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>
+
+There are no examples because WCY Broadcasts only come from one place and
+you either want them or not (see UNSET/WCY if you don't want them).
+
+This command is really provided for future use.
+
+See HELP FILTER for information.
+
+=== 8^ACCEPT/WCY <call> [input] [0-9] <pattern>^WCY 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/wcy node_default all
+  set/hops node_default 10
+
+=== 0^ACCEPT/WWV [0-9] <pattern>^set an 'accept' WWV filter
+It is unlikely that you will want to do this, but if you do then you can
+filter on the following fields:-
+
+  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>
+
+for example 
+
+  accept/wwv by_zone 4
+
+is probably the only useful thing to do (which will only show WWV broadcasts
+by stations in the US).
+
+See HELP FILTER for information.
+
+=== 8^ACCEPT/WWV <call> [input] [0-9] <pattern>^WWV 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/wwv db0sue-7 1 by_zone 4
+  accept/wwv node_default all
+  set/hops node_default 10
+
+  accept/wwv user_default by W,K
+
 === 0^ANNOUNCE <text>^Send an announcement to LOCAL users only
 <text> is the text of the announcement you wish to broadcast 
 
@@ -146,8 +208,8 @@ 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)
+  acc/spot 1 on hf/cw
+  acc/spot 2 on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
 
 and you say:-
 
@@ -155,7 +217,7 @@ and you say:-
 
 you will be left with:-
 
-  acc/spot 2 freq vhf and (by_zone 14,15,16 or call_zone 14,15,16)
+  acc/spot 2 on vhf and (by_zone 14,15,16 or call_zone 14,15,16)
 
 If you do:
 
@@ -401,21 +463,21 @@ 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)
+  accept/spots on 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
+  reject/spots on 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
+  reject/spots on 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
+  accept/spots not on 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
@@ -426,8 +488,8 @@ 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)  
+  reject/spots 1 on hf/cw
+  reject/spots 2 on 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
@@ -444,7 +506,7 @@ 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 
+  (on 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
@@ -453,7 +515,7 @@ 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
+  reject/spots 1 on hf/ssb
 
 or 
 
@@ -470,9 +532,9 @@ 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)
+  rej/spot on hf/cw
+  acc/spot on 0/30000
+  acc/spot 2 on 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.
@@ -485,6 +547,14 @@ thru everything else on HF.
 
 The next filter line lets through just VHF/UHF spots from EU.
 
+=== 8^FORWARD/LATLONG <node_call>^Send latitude and longitude information to another cluster
+This command sends all the latitude and longitude information that your
+cluster is holding against callsigns.  One advantage of recieving this
+information is that more locator information is held by you.  This
+means that more locators are given on the DX line assuming you have
+SET/DXGRID enabled.  This could be a LOT of information though, so
+it is not recommended on slow links.
+
 === 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
@@ -625,11 +695,6 @@ etc). eg:-
 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.
@@ -650,10 +715,11 @@ 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. 
-
+=== 1^PING <node call>^Check the link quality between nodes
+This command allows you to send a frame to another cluster node on
+the network and get a return frame.  The time it takes to do this
+is a good indication of the quality of the link.  The actual time
+it takes is output to the console in seconds.
 Any visible cluster node can be PINGed.
 
 === 1^RCMD <node call> <cmd>^Send a command to another DX Cluster
@@ -673,10 +739,10 @@ 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
+=== 0^REJECT/ANNOUNCE [0-9] <pattern>^Set a '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
+A 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.
 
@@ -713,16 +779,17 @@ default for nodes and users eg:-
   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. 
+=== 0^REJECT/SPOTS [0-9] <pattern>^Set a 'reject' filter line for spots
+Create a 'reject this spot' line for a filter. 
 
-An reject filter line means that if the spot matches this filter it is
+A 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
+  on <range>             same as 'freq'
   call <prefixes>        eg: G,PA,HB9
   info <string>          eg: iota or qsl
   by <prefixes>            
@@ -738,13 +805,13 @@ You can use any of the following things in this line:-
 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
+this is more efficient than saying simply: on 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)
+  rej/spot 1 on hf
+  rej/spot 2 on vhf and not (by_zone 14,15,16 or call_zone 14,15,16)
 
 You can use the tag 'all' to reject everything eg:
 
@@ -762,6 +829,65 @@ default for nodes and users eg:-
 
   reject/spot user_default by G,M,2
 
+=== 0^REJECT/WCY [0-9] <pattern>^set a 'reject' WCY filter
+It is unlikely that you will want to do this, but if you do then you can
+filter on the following fields:-
+
+  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>
+
+There are no examples because WCY Broadcasts only come from one place and
+you either want them or not (see UNSET/WCY if you don't want them).
+
+This command is really provided for future use.
+
+See HELP FILTER for information.
+
+=== 8^REJECT/WCY <call> [input] [0-9] <pattern>^WCY 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/wcy gb7djk all
+
+=== 0^REJECT/WWV [0-9] <pattern>^set a 'reject' WWV filter
+It is unlikely that you will want to do this, but if you do then you can
+filter on the following fields:-
+
+  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>
+
+for example 
+
+  reject/wwv by_zone 14,15,16
+
+is probably the only useful thing to do (which will only show WWV broadcasts
+by stations in the US).
+
+See HELP FILTER for information.
+
+=== 8^REJECT/WWV <call> [input] [0-9] <pattern>^WWV 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/wwv db0sue-7 1 by_zone 4
+  reject/wwv node_default all
+
+  reject/wwv user_default by W
+
 === 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
@@ -1000,10 +1126,6 @@ Tell the system where you are. For example:-
 Display all the bad node callsigns in the system, see SET/BADNODE
 for more information.
 
-=== 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.
@@ -1220,6 +1342,17 @@ example:-
 
 SH/QRA 52 41 N 0 58 E
 
+=== 0^SHOW/QRZ <callsign>^Show any callbook details on a callsign
+This command queries the QRZ callbook server on the internet
+and returns any information available for that callsign. This service
+is provided for users of this software by http://www.qrz.com 
+
+=== 0^SHOW/ROUTE <callsign> ...^Show the route to the callsign
+This command allows you to see which node the callsigns specified are
+connected. It is a sort of inverse sh/config.
+
+sh/route n2tly
+
 === 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.