X-Git-Url: http://dxcluster.net/gitweb/gitweb.cgi?a=blobdiff_plain;f=cmd%2FCommands_en.hlp;h=971765143762bae70c641a083b8f242e3b0aea51;hb=956e3acab807900fdbccc0e2fa5e999327a1c1ce;hp=c266fa580e3289f2de517a46824d00388cfb77c3;hpb=9cac31473878fc88778cb13d843fa77c5fd33d65;p=spider.git diff --git a/cmd/Commands_en.hlp b/cmd/Commands_en.hlp index c266fa58..97176514 100644 --- a/cmd/Commands_en.hlp +++ b/cmd/Commands_en.hlp @@ -11,6 +11,89 @@ # # Comment lines are indented before printing # +=== 0^ACCEPT/ANNOUNCE [0-9] ^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 eg: iota or qsl + by eg: G,M,2 + origin + origin_dxcc eg: 61,62 (from eg: sh/pre G) + origin_itu + origin_zone + by_dxcc + by_itu + by_zone + channel + wx 1 filter WX announces + dest 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 reject everything that is left, eg: + + acc/ann all + +=== 8^ACCEPT/ANNOUNCE [input] [0-9] ^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] ^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 eg: 0/30000 or hf or hf/cw or 6m,4m,2m + call eg: G,PA,HB9 + info eg: iota or qsl + by + call_dxcc eg: 61,62 (from eg: sh/pre G) + call_itu + call_zone + by_dxcc + by_itu + by_zone + origin + channel + +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 reject everything that is left, eg: + + ann/spot 3 all + +=== 8^ACCEPT/SPOTS [input] [0-9] ^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 ^Send an announcement to LOCAL users only is the text of the announcement you wish to broadcast @@ -26,14 +109,8 @@ the names of all the commands that may be relevant. === 0^BYE^Exit from the cluster This will disconnect you from the cluster -=== 5^CONNECT ^Start a connection to another DX Cluster -Start a connection process that will culminate in a new connection to the -DX cluster . This process creates a new 'client' process which will -use the script in /spider/connect/ to effect the 'chat' exchange -necessary to traverse the network(s) to logon to the cluster . - -=== 9^CATCH All|[ ...]^Mark a message as sent -=== 9^UNCATCH All|[msgno> ...]^Unmark a message as sent +=== 5^CATCHUP All|[ ...]^Mark a message as sent +=== 5^UNCATCHUP 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 @@ -41,16 +118,47 @@ 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:- - catch GB7DJK all - catch GB7DJK 300 301 302 303 + catchup GB7DJK all + catchup GB7DJK 300 301 302 303 500-510 and to undo what you have just done:- - uncatch GB7DJK all - uncatch GB7DJK 300 301 302 303 + 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 ^Start a connection to another DX Cluster +Start a connection process that will culminate in a new connection to the +DX cluster . This process creates a new 'client' process which will +use the script in /spider/connect/ to effect the 'chat' exchange +necessary to traverse the network(s) to logon to the cluster . + === 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. @@ -216,7 +324,131 @@ You can credit someone else by saying:- The is compared against the available bands set up in the cluster. See SHOW/BANDS for more information. -=== 1^FORWARD/OPERNAME ^Send out information on this to all clusters +=== 9^EXPORT ^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 []^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 .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 + +=== 1^FORWARD/OPERNAM ^Send out information on this 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. @@ -235,42 +467,81 @@ Look at the APROPOS command which will search the help database for the you specify and give you a list of likely commands to look at with HELP. +=== 5^INIT ^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 DISC/F ). + +Best of luck - you will need it. + === 0^KILL [ [ [/]^Ask for the latest spots and WWV MERGE allows you to bring your spot and wwv database up to date. By default @@ -308,9 +579,11 @@ You can look at the status of a message by using:- This will display more information on the message than DIR does. === 8^PC ^Send text (eg PC Protocol) to -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:- +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!!! @@ -363,6 +636,85 @@ 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] ^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 eg: iota or qsl + by eg: G,M,2 + origin + origin_dxcc eg: 61,62 (from eg: sh/pre G) + origin_itu + origin_zone + by_dxcc + by_itu + by_zone + channel + wx 1 filter WX announces + dest 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 that is left, eg: + + rej/ann all + +=== 8^REJECT/ANNOUNCE [input] [0-9] ^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] ^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 eg: 0/30000 or hf or hf/cw or 6m,4m,2m + call eg: G,PA,HB9 + info eg: iota or qsl + by + call_dxcc eg: 61,62 (from eg: sh/pre G) + call_itu + call_zone + by_dxcc + by_itu + by_zone + origin + channel + +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 that is left, eg: + + rej/spot 3 all + +=== 8^REJECT/SPOTS [input] [0-9] ^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 ^Reply (privately) to the specified message === 0^REPLY B ^Reply as a Bulletin to the specified message @@ -404,15 +756,40 @@ SP is an alias for SEND PRIVATE === 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 [..]^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 [..]^Make the callsign an CLX node + === 9^SET/DEBUG ^Add a debug level to the debug set === 9^UNSET/DEBUG ^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 [..]^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 @@ -453,11 +830,11 @@ then this command will set your QRA locator for you. For example:- Tell the system what your name is eg:- SET/NAME Dirk -=== 9^SET/NODE [..]^Make the callsign an AK1A cluster +=== 5^SET/NODE [..]^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. -=== 9^SET/OBSCOUNT ^Set the 'pump-up' obscelence counter +=== 8^SET/OBSCOUNT ^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 @@ -479,6 +856,8 @@ explicitly to 0 will disable paging. SET/PAGE 30 SET/PAGE 0 +The setting is stored in your user profile. + === 9^SET/PINGINTERVAL