X-Git-Url: http://gb7djk.dxcluster.net/gitweb/gitweb.cgi?a=blobdiff_plain;f=txt%2Fadminmanual.txt;h=0f92614254c22fd6a0e1d705eb0d33dc8213dd85;hb=fda0806cc0170c3c2060fbb14033b1fa5f06107d;hp=5887f5fc60f71bfefbccd830798bb06d78febae0;hpb=f522780bffd435c31b544944063da62a86f9c363;p=spider.git diff --git a/txt/adminmanual.txt b/txt/adminmanual.txt index 5887f5fc..0f926142 100644 --- a/txt/adminmanual.txt +++ b/txt/adminmanual.txt @@ -1,6 +1,6 @@ The DXSpider Administration Manual v1.49 - Ian Maude, G0VGS, (ianmaude@btinternet.com) - December 2001 revision 1.2 + Ian Maude, G0VGS, (g0vgs@ea1dav.net) + February 2002 revision 1.3 A reference for SysOps of the DXSpider DXCluster program. ______________________________________________________________________ @@ -1712,214 +1712,82 @@ 6.5. The Aliases file - You will find a file in /spider/cmd/ called Aliases. First, copy this - file to /spider/local_cmd/Aliases and edit this file. You will see - something like this ... - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + You will find a file in /spider/cmd/ called Aliases. This is the file + that controls what a user gets when issuing a command. It is also + possible to create your own aliases for databases and files you create + locally. + You should not alter the original file in /spider/cmd/ but create a + new file with the same name in /spider/local_cmd. This means that any + new Aliases files that is downloaded will not overwrite your self + created Aliases and also that you do not override any new Aliases with + your copy in /spider/local_cmd/. You must remember that any files you + store in /spider/local/ or /spider/local_cmd override the originals if + the same lines are used in both files. + The best way of dealing with all this then is to only put your own + locally created Aliases in the copy in /spider/local_cmd. The example + below is currently in use at GB7MBC. + # + # Local Aliases File + # - #!/usr/bin/perl + package CmdAlias; - # provide some standard aliases for commands for terminally - # helpless ak1a user (helpless in the sense that they never - # read nor understand help files) + %alias = ( + 'n' => [ + '^news$', 'type news', 'type', + ], + 's' => [ + '^sh\w*/buck$', 'show/qrz', 'show', + '^sh\w*/hftest$', 'dbshow hftest', 'dbshow', + '^sh\w*/qsl$', 'dbshow qsl', 'dbshow', + '^sh\w*/vhf$', 'dbshow vhf', 'dbshow', + '^sh\w*/vhftest$', 'dbshow vhftest', 'dbshow', + ], + ) - # This file is automagically reloaded if its modification time is - # later than the one stored in CmdAlias.pm - # PLEASE make this file consistant with reality! (the patterns MUST - # match the filenames!) - # Don't alter this file, copy it into the local_cmd tree and modify it. - # This file will be replaced everytime I issue a new release. - # You only need to put aliases in here for commands that don't work as - # you desire naturally, e.g sh/dx on its own just works as you expect - # so you need not add it as an alias. + Each alphabetical section should be preceded by the initial letter and + the section should be wrapped in square brackets as you can see. The + syntax is straightforward. The first section on each line is the new + command that will be allowed once the alias is included. The second + section is the command it is replacing and the last section is the + actual command that is being used. - package CmdAlias; + The eagle-eyed amongst you will have noticed that in the first + section, the new alias command has a '^' at the start and a '$' at the + end. Basically these force a perfect match on the alias. The '^' + says match the beginning exactly and the with similar commands. - %alias = ( - '?' => [ - '^\?', 'apropos', 'apropos', - ], - 'a' => [ - '^ann.*/full', 'announce full', 'announce', - '^ann.*/sysop', 'announce sysop', 'announce', - '^ann.*/(.*)$', 'announce $1', 'announce', - ], - 'b' => [ - ], - 'c' => [ - ], - 'd' => [ - '^del', 'kill', 'kill', - '^del\w*/fu', 'kill full', 'kill', - '^di\w*/a\w*', 'directory all', 'directory', - '^di\w*/b\w*', 'directory bulletins', 'directory', - '^di\w*/n\w*', 'directory new', 'directory', - '^di\w*/o\w*', 'directory own', 'directory', - '^di\w*/s\w*', 'directory subject', 'directory', - '^di\w*/t\w*', 'directory to', 'directory', - '^di\w*/f\w*', 'directory from', 'directory', - '^di\w*/(\d+)', 'directory $1', 'directory', - ], - 'e' => [ - ], - 'f' => [ - ], - 'g' => [ - ], - 'h' => [ - ], - 'i' => [ - ], - 'j' => [ - ], - 'k' => [ - ], - 'l' => [ - '^l$', 'directory', 'directory', - '^ll$', 'directory', 'directory', - '^ll/(\d+)', 'directory $1', 'directory', - ], - 'm' => [ - ], - 'n' => [ - '^news', 'type news', 'type', - ], - 'o' => [ - ], - 'p' => [ - ], - 'q' => [ - '^q', 'bye', 'bye', - ], - 'r' => [ - '^r$', 'read', 'read', - '^rcmd/(\S+)', 'rcmd $1', 'rcmd', - ], - 's' => [ - '^s/p$', 'send', 'send', - '^sb$', 'send noprivate', 'send', - '^set/home$', 'set/homenode', 'set/homenode', - '^set/nobe', 'unset/beep', 'unset/beep', - '^set/nohe', 'unset/here', 'unset/here', - '^set/noan', 'unset/announce', 'unset/announce', - '^set/nodx', 'unset/dx', 'unset/dx', - '^set/nota', 'unset/talk', 'unset/talk', - '^set/noww', 'unset/wwv', 'unset/wwv', - '^set/nowx', 'unset/wx', 'unset/wx', - '^sh$', 'show', 'show', - '^sh\w*/buck', 'dbshow buck', 'dbshow', - '^sh\w*/bu', 'show/files bulletins', 'show/files', - '^sh\w*/c/n', 'show/configuration nodes', 'show/configuration', - '^sh\w*/c$', 'show/configuration', 'show/configuration', - '^sh\w*/com', 'dbavail', 'dbavail', - '^sh\w*/dx/(\d+)-(\d+)', 'show/dx $1-$2', 'show/dx', - '^sh\w*/dx/(\d+)', 'show/dx $1', 'show/dx', - '^sh\w*/dx/d(\d+)', 'show/dx from $1', 'show/dx', - '^sh\w*/email', 'dbshow email', 'dbshow', - '^sh\w*/hftest', 'dbshow hftest', 'dbshow', - '^sh\w*/vhftest', 'dbshow vhftest', 'dbshow', - '^sh\w*/qsl', 'dbshow qsl', 'dbshow', - '^sh\w*/tnc', 'who', 'who', - '^sh\w*/up', 'show/cluster', 'show/cluster', - '^sh\w*/w\w*/(\d+)-(\d+)', 'show/wwv $1-$2', 'show/wwv', - '^sh\w*/w\w*/(\d+)', 'show/wwv $1', 'show/wwv', - '^sp$', 'send', 'send', - - ], - 't' => [ - '^ta$', 'talk', 'talk', - '^t$', 'talk', 'talk', - ], - 'u' => [ - ], - 'v' => [ - ], - 'w' => [ - '^wx/full', 'wx full', 'wx', - '^wx/sysop', 'wx sysop', 'wx', - ], - 'x' => [ - ], - 'y' => [ - ], - 'z' => [ - ], - ) + I have 3 different types of alias in this file. At the top is an + alias for 'news'. This is a file I have created in the + /spider/packclus/ directory where I can inform users of new + developments or points of interest. In it's initial form a user would + have to use the command type news. The alias allows them to simply + type news to get the info. Second is an alias for the show/qrz + command so that those users used to the original show/buck command in + AK1A will not get an error, and the rest of the lines are for locally + created databases so that a user can type show/hftest instead of + having to use the command dbshow hftest which is not as intuitive. + This file is just an example and you should edit it to your own + requirements. Once created, simply issue the command load/alias at + the cluster prompt as the sysop user and the aliases should be + available. - 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. 6.6. Console.pl @@ -1950,9 +1818,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 ... @@ -1964,6 +1834,7 @@ + Now go back to the cluster and issue the command ... @@ -1973,9 +1844,9 @@ - That is it! the kepler data has been updated. + That is it! the kepler data has been updated. 6.8. The QRZ callbook @@ -2040,6 +1911,7 @@ registered users, use the command show/register. + 7.2. Passwords At the moment, passwords only affect users who login to a DXSpider @@ -2106,10 +1978,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 @@ -2238,9 +2110,9 @@ dest eg: 6MUK,WDX (distros) + some examples:- - some examples:- acc/ann dest 6MUK acc/ann 2 by_zone 14,15,16 @@ -2304,10 +2176,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 @@ -2358,19 +2230,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 + + @@ -2432,23 +2318,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 @@ -2490,15 +2368,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 @@ -2506,6 +2390,7 @@ for example + accept/wwv by_zone 4 @@ -2555,9 +2440,6 @@ This command will send your announcement across the whole cluster network. - - - 9.12. announce sysop (5) announce sysop @@ -2571,7 +2453,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. @@ -2637,7 +2518,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 @@ -2701,9 +2581,6 @@ node_default or user_default. - - - 9.20. clear/wcy (0) clear/wcy [1|all] Clear a WCY filter line @@ -2826,6 +2703,7 @@ to allow + SH/BUCK g1tlh to work as they may be used to. @@ -2834,8 +2712,6 @@ databases. See DBSHOW for generic database enquiry - - 9.27. dbimport (9) dbimport Import AK1A data into a database @@ -2894,11 +2770,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 - @@ -2959,15 +2834,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 @@ -3021,7 +2901,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 @@ -3034,6 +2915,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 @@ -3165,7 +3047,6 @@ clear/spots 1 - To remove the filter in its entirty:- clear/spots all @@ -3283,6 +3164,8 @@ same subject will be deleted. Beware! + + 9.46. kill/expunge (6) kill/expunge [..]Expunge a message @@ -3298,6 +3181,7 @@ It otherwise is used in the same way as the KILL command. + 9.47. links (0) links Show which nodes are physically connected @@ -3348,7 +3232,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. @@ -3364,6 +3247,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 @@ -3413,37 +3298,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 @@ -3487,6 +3361,9 @@ + + + 9.60. rcmd (1) rcmd Send a command to another DX cluster @@ -3495,7 +3372,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) @@ -3553,6 +3429,7 @@ + some examples:- @@ -3619,16 +3496,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) @@ -3690,10 +3562,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: