X-Git-Url: http://gb7djk.dxcluster.net/gitweb/gitweb.cgi?a=blobdiff_plain;f=txt%2Fadminmanual.txt;h=d8078515dd125c5efae856265fa768b1e498f5d3;hb=7505989c04f2d3ff01ca126407c1dcd17e4bc62b;hp=d82170ac182f5bf0d33125d5e0958d7c5488ebce;hpb=b1d4f4f651821a3ecefdd59ddb09ce9d190b66d6;p=spider.git diff --git a/txt/adminmanual.txt b/txt/adminmanual.txt index d82170ac..d8078515 100644 --- a/txt/adminmanual.txt +++ b/txt/adminmanual.txt @@ -1,6 +1,6 @@ - The DXSpider Administration Manual v1.48 + The DXSpider Administration Manual v1.49 Ian Maude, G0VGS, (ianmaude@btinternet.com) - Version 1.49 November 2001 revision 1.1 + December 2001 revision 1.2 A reference for SysOps of the DXSpider DXCluster program. ______________________________________________________________________ @@ -916,12 +916,33 @@ how the file works. + SHould any of the nodecalls include an ssid, it is important to wrap + the whole call in single quotes, like this ... + + + + + 'DB0FHF-15' => { + 11 => 5, + 12 => 8, + 16 => 8, + 17 => 8, + 19 => 8, + 21 => 8, + }, + + + + + If you do not do this, you will get errors and the file will not work + as expected. + + You can alter this file at any time, including whilst the cluster is running. If you alter the file during runtime, the command load/hops will bring your changes into effect. - 1.11. Hop Control on Specific Nodes You can set a callsign specific hop count for any of the standard @@ -984,38 +1005,34 @@ + # the list of regexes for messages that we won't store having + # received them (bear in mind that we must receive them fully before + # we can bin them) + # The format of each line is as follows + # type source pattern + # P/B/F T/F/O/S regex - # the list of regexes for messages that we won't store having - # received them (bear in mind that we must receive them fully before - # we can bin them) - - - # The format of each line is as follows - - # type source pattern - # P/B/F T/F/O/S regex - - # type: P - private, B - bulletin (msg), F - file (ak1a bull) - # source: T - to field, F - from field, O - origin, S - subject - # pattern: a perl regex on the field requested + # type: P - private, B - bulletin (msg), F - file (ak1a bull) + # source: T - to field, F - from field, O - origin, S - subject + # pattern: a perl regex on the field requested - # Currently only type B and P msgs are affected by this code. - # - # The list is read from the top down, the first pattern that matches - # causes the action to be taken. + # Currently only type B and P msgs are affected by this code. + # + # The list is read from the top down, the first pattern that matches + # causes the action to be taken. - # The pattern can be undef or 0 in which case it will always be selected - # for the action specified + # The pattern can be undef or 0 in which case it will always be selected + # for the action specified - package DXMsg; + package DXMsg; - @badmsg = ( - ); + @badmsg = ( + ); @@ -1100,6 +1117,9 @@ of show/baddx, show/badspotter and show/badnode. + + + 3. Mail DXSpider deals seamlessly with standard AK1A type mail. It supports @@ -1120,6 +1140,8 @@ default method of sending mail and so a simple s for send will do. A full list of the send commands and options is in the command set section, so I will not duplicate them here. + + 3.2. Bulletin mail Bulletin mail is sent by using the sb command. This is one of the @@ -1147,41 +1169,58 @@ - # - # this is an example message forwarding file for the system - # - # The format of each line is as follows - # - # type to/from/at pattern action destinations - # P/B/F T/F/A regex I/F [ call [, call ...] ] - # - # type: P - private, B - bulletin (msg), F - file (ak1a bull) - # to/from/at: T - to field, F - from field, A - home bbs, O - origin - # pattern: a perl regex on the field requested - # action: I - ignore, F - forward - # destinations: a reference to an array containing node callsigns - # - # if it is non-private and isn't in here then it won't get forwarded - # - # Currently only type B msgs are affected by this code. - # - # The list is read from the top down, the first pattern that matches - # causes the action to be taken. - # - # The pattern can be undef or 0 in which case it will always be selected - # for the action specified - # - # If the BBS list is undef or 0 and the action is 'F' (and it matches the - # pattern) then it will always be forwarded to every node that doesn't have - # it (I strongly recommend you don't use this unless you REALLY mean it, if - # you allow a new link with this on EVERY bull will be forwarded immediately - # on first connection) - # - package DXMsg; - @forward = ( - ); + + + + + + + + + + + + + + + + # + # this is an example message forwarding file for the system + # + # The format of each line is as follows + # + # type to/from/at pattern action destinations + # P/B/F T/F/A regex I/F [ call [, call ...] ] + # + # type: P - private, B - bulletin (msg), F - file (ak1a bull) + # to/from/at: T - to field, F - from field, A - home bbs, O - origin + # pattern: a perl regex on the field requested + # action: I - ignore, F - forward + # destinations: a reference to an array containing node callsigns + # + # if it is non-private and isn't in here then it won't get forwarded + # + # Currently only type B msgs are affected by this code. + # + # The list is read from the top down, the first pattern that matches + # causes the action to be taken. + # + # The pattern can be undef or 0 in which case it will always be selected + # for the action specified + # + # If the BBS list is undef or 0 and the action is 'F' (and it matches the + # pattern) then it will always be forwarded to every node that doesn't have + # it (I strongly recommend you don't use this unless you REALLY mean it, if + # you allow a new link with this on EVERY bull will be forwarded immediately + # on first connection) + # + + package DXMsg; + + @forward = ( + ); @@ -1205,20 +1244,28 @@ - MSG TO - change TO callsign to - MSG FRom - change FROM callsign to - MSG PRrivate - set private flag - MSG NOPRrivate - unset private flag - MSG RR - set RR flag - MSG NORR - unset RR flag - MSG KEep - set the keep flag (message won't be deleted ever) - MSG NOKEep - unset the keep flag - MSG SUbject - change the subject to - MSG WAittime - remove any waiting time for this message - MSG NOREad - mark message as unread - MSG REad - mark message as read - MSG QUeue - queue any outstanding bulletins - MSG QUeue 1 - queue any outstanding private messages + + + + + + + + + MSG TO - change TO callsign to + MSG FRom - change FROM callsign to + MSG PRrivate - set private flag + MSG NOPRrivate - unset private flag + MSG RR - set RR flag + MSG NORR - unset RR flag + MSG KEep - set the keep flag (message won't be deleted ever) + MSG NOKEep - unset the keep flag + MSG SUbject - change the subject to + MSG WAittime - remove any waiting time for this message + MSG NOREad - mark message as unread + MSG REad - mark message as read + MSG QUeue - queue any outstanding bulletins + MSG QUeue 1 - queue any outstanding private messages @@ -1252,6 +1299,10 @@ Times read: 0 G0VGS de GB7MBC 28-Jan-2001 1308Z > + + + + 3.6. Filtering mail This is described in the section on Other filters so I will not @@ -1267,7 +1318,6 @@ SYSOP.pl that caters for the UK sysops. - qw(GB7TLH GB7DJK GB7DXM GB7CDX GB7BPQ GB7DXN GB7MBC GB7MBC-6 GB7MDX GB7NDX GB7SDX GB7TDX GB7UDX GB7YDX GB7ADX GB7BAA GB7DXA GB7DXH GB7DXK GB7DXI GB7DXS) @@ -1310,26 +1360,18 @@ - - - - - - - - - # - # startup script example - # - # set maximum no of spots allowed to 100 - # set/var $Spot::maxspots = 1 - # - # Set registration on - # set/var $main::reqreg = 1 - # - # Set passwords on - # set/var $main::passwdreq = 1 - # + # + # startup script example + # + # set maximum no of spots allowed to 100 + # set/var $Spot::maxspots = 1 + # + # Set registration on + # set/var $main::reqreg = 1 + # + # Set passwords on + # set/var $main::passwdreq = 1 + # @@ -1342,8 +1384,6 @@ eventually users will be able to set their own. An example is included in the distibution but here is a further example. - - # # G0FYD # @@ -1450,6 +1490,7 @@ + This will update the existing local oblast database or create it if it does not exist. @@ -1473,6 +1514,8 @@ + + 5.4. Looking up databases To look for information in a defined database, simply use the dbshow @@ -1516,6 +1559,7 @@ If you remove a database it ceases to exist and would have to be created from scratch if you still required it. + 6. Information, files and useful programs 6.1. MOTD @@ -1536,6 +1580,8 @@ registered they will receive the same message as any other user. + + 6.3. Downtime message If for any reason the cluster is down, maybe for upgrade or @@ -1602,7 +1648,6 @@ - You can see that in the files area (basically the packclus directory) there is a file called news and a directory called bulletin. You can also see that dates they were created. In the case of the file news, @@ -1645,22 +1690,19 @@ - - - - type bulletin/opdx391 - Ohio/Penn DX Bulletin No. 391 - The Ohio/Penn Dx PacketCluster - DX Bulletin No. 391 - BID: $OPDX.391 - January 11, 1999 - Editor Tedd Mirgliotta, KB8NW - Provided by BARF-80 BBS Cleveland, Ohio - Online at 440-237-8208 28.8k-1200 Baud 8/N/1 (New Area Code!) - Thanks to the Northern Ohio Amateur Radio Society, Northern Ohio DX - Association, Ohio/Penn PacketCluster Network, K1XN & Golist, WB2RAJ/WB2YQH - & The 59(9) DXReport, W3UR & The Daily DX, K3TEJ, KN4UG, W4DC, NC6J, N6HR, - Press Enter to continue, A to abort (508 lines) > + type bulletin/opdx391 + Ohio/Penn DX Bulletin No. 391 + The Ohio/Penn Dx PacketCluster + DX Bulletin No. 391 + BID: $OPDX.391 + January 11, 1999 + Editor Tedd Mirgliotta, KB8NW + Provided by BARF-80 BBS Cleveland, Ohio + Online at 440-237-8208 28.8k-1200 Baud 8/N/1 (New Area Code!) + Thanks to the Northern Ohio Amateur Radio Society, Northern Ohio DX + Association, Ohio/Penn PacketCluster Network, K1XN & Golist, WB2RAJ/WB2YQH + & The 59(9) DXReport, W3UR & The Daily DX, K3TEJ, KN4UG, W4DC, NC6J, N6HR, + Press Enter to continue, A to abort (508 lines) > @@ -1693,6 +1735,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + @@ -1851,6 +1917,7 @@ + You can create aliases for commands at will. Beware though, these may not always turn out as you think. Care is needed and you need to test the results once you have set an alias. @@ -1884,9 +1951,11 @@ + would export message number 5467 as a file called keps.in in the /spider/perl directory. + Now login to a VT as sysop and cd /spider/perl. There is a command in the perl directory called convkeps.pl. All we need to do now is convert the file like so ... @@ -1898,6 +1967,7 @@ + Now go back to the cluster and issue the command ... @@ -1907,9 +1977,8 @@ - That is it! the kepler data has been updated. - + That is it! the kepler data has been updated. 6.8. The QRZ callbook @@ -1974,6 +2043,7 @@ registered users, use the command show/register. + 7.2. Passwords At the moment, passwords only affect users who login to a DXSpider @@ -2040,10 +2110,10 @@ CVS repository and then update your Spider source. There are several steps which are listed below ... - First login as the user sysop. Next you need to connect to the CVS repository. You do this with the command below ... + cvs -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login @@ -2172,9 +2242,9 @@ dest eg: 6MUK,WDX (distros) + some examples:- - some examples:- acc/ann dest 6MUK acc/ann 2 by_zone 14,15,16 @@ -2238,10 +2308,10 @@ 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:- + call the callsign of the thingy call_dxcc eg: 61,62 (from eg: sh/pre G) call_itu @@ -2278,7 +2348,7 @@ 9.4. accept/spots (0) - accept/announce [0-9] Set an accept filter line for spots + accept/spots [0-9] Set an accept filter line for spots Create an 'accept this spot' line for a filter. @@ -2292,19 +2362,33 @@ - freq eg: 0/30000 or hf or hf/cw or 6m,4m,2m - on same as 'freq' - 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 + + + + + + + + + + + + + freq eg: 0/30000 or hf or hf/cw or 6m,4m,2m + on same as 'freq' + 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 + + @@ -2366,23 +2450,15 @@ - - - - - - - - - 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 + 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 @@ -2424,15 +2500,21 @@ - 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 + + + + + + + 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 @@ -2440,6 +2522,7 @@ for example + accept/wwv by_zone 4 @@ -2489,9 +2572,6 @@ This command will send your announcement across the whole cluster network. - - - 9.12. announce sysop (5) announce sysop @@ -2505,7 +2585,6 @@ apropos Search the help database - Search the help database for (it isn't case sensitive), and print the names of all the commands that may be relevant. @@ -2571,7 +2650,6 @@ This command allows you to clear (remove) a line in a route filter or to remove the whole filter. - see CLEAR/SPOTS for a more detailed explanation. A sysop can clear an input or normal output filter for a user or the @@ -2635,9 +2713,6 @@ node_default or user_default. - - - 9.20. clear/wcy (0) clear/wcy [1|all] Clear a WCY filter line @@ -2760,6 +2835,7 @@ to allow + SH/BUCK g1tlh to work as they may be used to. @@ -2768,8 +2844,6 @@ databases. See DBSHOW for generic database enquiry - - 9.27. dbimport (9) dbimport Import AK1A data into a database @@ -2828,11 +2902,10 @@ 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 - DBSHOW buck G1TLH - @@ -2893,15 +2966,20 @@ - DIR TO G1TLH 5 - or - DIR SUBJECT IOTA 200-250 + + + 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 @@ -2955,7 +3033,8 @@ - DX by G1TLH FR0G 144.600 he isn't on the cluster + + DX by G1TLH FR0G 144.600 he isn't on the cluster @@ -2968,6 +3047,7 @@ 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 @@ -3099,7 +3179,6 @@ clear/spots 1 - To remove the filter in its entirty:- clear/spots all @@ -3217,6 +3296,8 @@ same subject will be deleted. Beware! + + 9.46. kill/expunge (6) kill/expunge [..]Expunge a message @@ -3232,6 +3313,7 @@ It otherwise is used in the same way as the KILL command. + 9.47. links (0) links Show which nodes are physically connected @@ -3282,7 +3364,6 @@ 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. @@ -3298,6 +3379,8 @@ 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.53. load/forward (9) load/forward Reload the msg forwarding routing table @@ -3347,37 +3430,26 @@ msg [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 - change TO callsign to - MSG FRom - change FROM callsign to - MSG PRrivate - set private flag - MSG NOPRrivate - unset private flag - MSG RR - set RR flag - MSG NORR - unset RR flag - MSG KEep - set the keep flag (message won't be deleted ever) - MSG NOKEep - unset the keep flag - MSG SUbject - change the subject to - MSG WAittime - remove any waitting time for this message - MSG NOREad - mark message as unread - MSG REad - mark message as read - MSG QUeue - queue any outstanding bulletins - MSG QUeue 1 - queue any outstanding private messages + MSG TO - change TO callsign to + MSG FRom - change FROM callsign to + MSG PRrivate - set private flag + MSG NOPRrivate - unset private flag + MSG RR - set RR flag + MSG NORR - unset RR flag + MSG KEep - set the keep flag (message won't be deleted ever) + MSG NOKEep - unset the keep flag + MSG SUbject - change the subject to + MSG WAittime - remove any waitting time for this message + MSG NOREad - mark message as unread + MSG REad - mark message as read + MSG QUeue - queue any outstanding bulletins + MSG QUeue 1 - queue any outstanding private messages @@ -3421,6 +3493,9 @@ + + + 9.60. rcmd (1) rcmd Send a command to another DX cluster @@ -3429,7 +3504,6 @@ 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) @@ -3487,6 +3561,7 @@ + some examples:- @@ -3553,16 +3628,11 @@ origin_itu origin_zone - - - - some examples:- - - rej/route gb7djk call_dxcc 61,38 (everything except UK+EIRE nodes) + rej/route gb7djk call_dxcc 61,38 (everything except UK+EIRE nodes) @@ -3624,10 +3694,6 @@ 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: