updated documentation a bit
[spider.git] / html / adminmanual-6.html
index 2f6d3ed8b67a72bea60e27168aaeb9c86d4d29dd..d10109d0f7a3a924f7449334675fafa21da4ce4d 100644 (file)
@@ -2,10 +2,11 @@
 <HTML>
 <HEAD>
  <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
- <TITLE>The DXSpider Installation and Administration Manual : Information, files and useful programs</TITLE>
+ <TITLE>The DXSpider Administration Manual v1.48: Information, files and useful programs</TITLE>
  <LINK HREF="adminmanual-7.html" REL=next>
  <LINK HREF="adminmanual-5.html" REL=previous>
  <LINK HREF="adminmanual.html#toc6" REL=contents>
+<link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
 </HEAD>
 <BODY>
 <A HREF="adminmanual-7.html">Next</A>
 <H2><A NAME="ss6.1">6.1 MOTD</A>
 </H2>
 
-<P>One of the more important things a cluster sysop needs to do is to get information to his users.  The simplest way to do this is to have a banner that is sent to the user on login.  This is know as a "message of the day" or "motd".  To set this up, simply create a file in /spider/data called motd and edit it to say whatever you want.  It is purely a text file and will be sent automatically to anyone logging in to the cluster.
+<P>One of the more important things a cluster sysop needs to do is to get 
+information to his users.  The simplest way to do this is to have a banner 
+that is sent to the user on login.  This is know as a "message of the day" 
+or "motd".  To set this up, simply create a file in /spider/data called motd 
+and edit it to say whatever you want.  It is purely a text file and will be 
+sent automatically to anyone logging in to the cluster.
 <P>
 <H2><A NAME="ss6.2">6.2 Downtime message</A>
 </H2>
 
-<P>If for any reason the cluster is down, maybe for upgrade or maintenance but the machine is still running, a message can be sent to the user advising them of the fact.  This message lives in the /spider/data directory and is called "offline".  Simply create the file and edit it to say whatever you wish.  This file will be sent to a user attempting to log into the cluster when DXSpider is not actually running.
+<P>If for any reason the cluster is down, maybe for upgrade or maintenance but 
+the machine is still running, a message can be sent to the user advising them 
+of the fact.  This message lives in the /spider/data directory and is called
+"offline".  Simply create the file and edit it to say whatever you wish.  
+This file will be sent to a user attempting to log into the cluster when
+DXSpider is not actually running.
 <P>
 <H2><A NAME="ss6.3">6.3 Other text messages</A>
 </H2>
 
-<P>You can set other text messages to be read by the user if they input the file name.  This could be for news items or maybe information for new users.  To set this up, make a directory under /spider called <EM>packclus</EM>.  Under this directory you can create files called <EM>news</EM> or <EM>newuser</EM> for example.  In fact you can create files with any names you like.  These can be listed by the user with the command ....
+<P>You can set other text messages to be read by the user if they input the file 
+name.  This could be for news items or maybe information for new users.  
+To set this up, make a directory under /spider called <EM>packclus</EM>.  
+Under this directory you can create files called <EM>news</EM> or <EM>newuser</EM>
+for example.  In fact you can create files with any names you like.  These can 
+be listed by the user with the command ....
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
@@ -41,13 +57,21 @@ show/files
 type news
 </PRE>
 </CODE></BLOCKQUOTE>
-<P>If the file they want to read is called <EM>news</EM>.  You could also set an alias for this in the Alias file to allow them just to type <EM>news</EM>
+<P>If the file they want to read is called <EM>news</EM>.  You could also set 
+an alias for this in the Alias file to allow them just to type <EM>news</EM>
 <P>
-<P>You can also store other information in this directory, either directly or nested under directories.  One use for this would be to store DX bulletins such as the OPDX bulletins.  These can be listed and read by the user.  To keep things tidy, make a directory under /spider/packclus called <EM>bulletins</EM>.  Now copy any OPDX or similar bulletins into it.  These can be listed by the user in the same way as above using the <EM>show/files</EM> command with an extension for the bulletins directory you have just created, like this ....
+<P>You can also store other information in this directory, either directly or 
+nested under directories.  One use for this would be to store DX bulletins 
+such as the OPDX bulletins.  These can be listed and read by the user.  
+To keep things tidy, make a directory under /spider/packclus called
+<EM>bulletin</EM>.  Now copy any OPDX or similar bulletins into it.  These 
+can be listed by the user in the same way as above using the <EM>show/files</EM>
+command with an extension for the bulletin directory you have just created, 
+like this ....
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
-show/files bulletins
+show/files bulletin
 </PRE>
 </CODE></BLOCKQUOTE>
 <P>
@@ -56,21 +80,26 @@ show/files bulletins
 <BLOCKQUOTE><CODE>
 <PRE>
 sh/files
-bulletins      DIR 20-Dec-1999 1715Z news          1602 14-Dec-1999 1330Z
+bulletin      DIR 20-Dec-1999 1715Z news          1602 14-Dec-1999 1330Z
 </PRE>
 </CODE></BLOCKQUOTE>
-<P>You can see that in the files area (basically the packclus directory) there is a file called <EM>news</EM> and a directory called <EM>bulletins</EM>.  You can also see that dates they were created.  In the case of the file <EM>news</EM>, you can also see the time it was last modified, a good clue as to whether the file has been updated since you last read it.  To read the file called <EM>news</EM> you would simply issue the command ....
+<P>You can see that in the files area (basically the packclus directory) there is a 
+file called <EM>news</EM> and a directory called <EM>bulletin</EM>.  You can 
+also see that dates they were created.  In the case of the file <EM>news</EM>, 
+you can also see the time it was last modified, a good clue as to whether the 
+file has been updated since you last read it.  To read the file called 
+<EM>news</EM> you would simply issue the command ....
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
 type news
 </PRE>
 </CODE></BLOCKQUOTE>
-<P>To look what is in the bulletins directory you issue the command ....
+<P>To look what is in the bulletin directory you issue the command ....
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
-show/files bulletins
+show/files bulletin
 opdx390      21381 29-Nov-1999 1621Z opdx390.1     1670 29-Nov-1999 1621Z
 opdx390.2     2193 29-Nov-1999 1621Z opdx391      25045 29-Nov-1999 1621Z  
 opdx392      35969 29-Nov-1999 1621Z opdx393      15023 29-Nov-1999 1621Z  
@@ -91,7 +120,7 @@ Press Enter to continue, A to abort (16 lines) >
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
-type bulletins/opdx391
+type bulletin/opdx391
 Ohio/Penn DX Bulletin No. 391
 The Ohio/Penn Dx PacketCluster
 DX Bulletin No. 391
@@ -111,7 +140,8 @@ Press Enter to continue, A to abort (508 lines) >
 <H2><A NAME="ss6.4">6.4 The Aliases file</A>
 </H2>
 
-<P>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 ...
+<P>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 ...
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
@@ -224,7 +254,7 @@ package CmdAlias;
           '^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*/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',
@@ -251,103 +281,65 @@ package CmdAlias;
 )
 </PRE>
 </CODE></BLOCKQUOTE>
-<P>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.
+<P>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.
 <P>
-<H2><A NAME="ss6.5">6.5 Forward.pl</A>
+<H2><A NAME="ss6.5">6.5 Console.pl</A>
 </H2>
 
-<P>DXSpider receives all and any mail sent to it without any alterations needed
-in files.  Because personal and bulletin mail are treated differently, there
-is no need for a list of accepted bulletin addresses.  It is necessary, however,
-to tell the program which links accept which bulletins.  For example, it is
-pointless sending bulletins addresses to "UK" to any links other than UK
-ones.  The file that does this is called forward.pl and lives in /spider/msg.
-At default, like other spider files it is named forward.pl.issue.  Rename it
-to forward.pl and edit the file to match your requirements.
-The format is below ...
+<P>In later versions of Spider a simple console program is provided for the sysop.  
+This has a type ahead buffer with line editing facilities and colour for spots,
+announces etc.  To use this program, simply use console.pl instead of client.
+<P>
+<P>To edit the colours, copy /spider/perl/Console.pl to /spider/local and edit the 
+file with your favourite editor.
+<P>
+<H2><A NAME="ss6.6">6.6 Updating kepler data</A>
+</H2>
+
+<P>Spider has a powerful and flexible show/satellite command.  In order for
+this to be accurate, the kepler data has to be updated regularly.  In
+general, this data is available as an email or via cluster mail.
+Updating it is simple.  First you need to export the mail message as a
+file.  You do this with the <EM>export</EM> command from the cluster prompt
+as the sysop.  For example ...
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
-#
-# 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 = (
-'B',    'T',    'LOCAL',        'F',    [ qw(GB7MBC) ],
-'B',    'T',    'ALL',          'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
-'B',    'T',    'UK',           'F',    [ qw(GB7BAA GB7ADX) ],
-'B',    'T',    'QSL',          'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
-'B',    'T',    'QSLINF',       'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
-'B',    'T',    'DX',           'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
-'B',    'T',    'DXINFO',       'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
-'B',    'T',    'DXNEWS',       'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
-'B',    'T',    'DXQSL',        'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
-'B',    'T',    'SYSOP',        'F',    [ qw(GB7BAA GB7ADX) ],
-'B',    'T',    '50MHZ',        'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
-);
+export 5467 /spider/perl/keps.in
 </PRE>
 </CODE></BLOCKQUOTE>
-<P>Simply insert a bulletin address and state in the brackets where you wish
-that mail to go.  For example, you can see here that mail sent to "UK" will
-only be sent to the UK links and not to PA4AB-14.
-<P>
-<P>At the moment, once the file is edited, the program will need to be restarted
-for the changes to take effect.
+<P>would export message number 5467 as a file called keps.in in the
+/spider/perl directory.
+<P>Now login to a VT as sysop and cd /spider/perl.  There is a command in
+the perl directory called <EM>convkeps.pl</EM>.  All we need to do now is
+convert the file like so ...
 <P>
-<H2><A NAME="ss6.6">6.6 Distribution lists</A>
-</H2>
-
-<P>Distribution lists are simply a list of users to send certain types of
-mail to.  An example of this is mail you only wish to send to other
-sysops.  In /spider/msg there is a directory called <EM>distro</EM>.  You
-put any distibution lists in here.  For example, here is a file called
-SYSOP.pl that caters for the UK sysops.
+<BLOCKQUOTE><CODE>
+<PRE>
+./convkeps.pl keps.in
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>Now go back to the cluster and issue the command ...
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
-qw(GB7TLH GB7DJK GB7DXM GB7CDX GB7BPQ GB7DXN GB7MBC GB7MBC-6 GB7MDX
-   GB7NDX GB7SDX GB7TDX GB7UDX GB7YDX GB7ADX GB7BAA GB7DXA GB7DXH 
-   GB7DXK GB7DXI GB7DXS)
+load/keps
 </PRE>
 </CODE></BLOCKQUOTE>
-<P>Any mail sent to "sysop" would only be sent to the callsigns in this list.
+<P>That is it!  the kepler data has been updated.
 <P>
-<H2><A NAME="ss6.7">6.7 Console.pl</A>
+<H2><A NAME="ss6.7">6.7 The QRZ callbook</A>
 </H2>
 
-<P>In later versions of Spider a simple console program is provided for the sysop.  This has a type ahead buffer with line editing facilities and colour for spots, announces etc.
-To use this program, simply use console.pl instead of client.pl.
-<P>
-<P>To edit the colours, copy /spider/perl/Console.pl to /spider/local and edit the file with your favourite editor.
+<P>The command <EM>sh/qrz</EM> will only work once you have followed a few
+simple steps.  First you need to get a user ID and password from qrz.com.
+Simply go to the site and create one.  Secondly you need to copy the file
+/spider/perl/Internet.pm to /spider/local and alter it to match your user
+ID and password.  You also at this point need to set $allow=1 to complete
+the setup.  Many thanks to Fred Lloyd, the proprieter of
+<A HREF="http://www.qrz.com">qrz.com</A> for allowing this access.
 <P>
 <HR>
 <A HREF="adminmanual-7.html">Next</A>