Add section on mail to manual. Added adminmanual-12.html
[spider.git] / html / adminmanual-9.html
index 2a8217a6fbde8bd7bdab848c3d2dd6b6eed8c2c7..48a6caa75fb299062605cab5791c17c41d4623fb 100644 (file)
 <HTML>
 <HEAD>
  <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
- <TITLE>The DXSpider Installation and Administration Manual : CVS</TITLE>
+ <TITLE>The DXSpider Installation and Administration Manual : Mail</TITLE>
  <LINK HREF="adminmanual-10.html" REL=next>
  <LINK HREF="adminmanual-8.html" REL=previous>
  <LINK HREF="adminmanual.html#toc9" REL=contents>
+<link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
 </HEAD>
 <BODY>
 <A HREF="adminmanual-10.html">Next</A>
 <A HREF="adminmanual-8.html">Previous</A>
 <A HREF="adminmanual.html#toc9">Contents</A>
 <HR>
-<H2><A NAME="s9">9. CVS</A></H2>
+<H2><A NAME="s9">9. Mail</A></H2>
 
-<P>CVS stands for "Concurrent Versions System" and the CVS for DXSpider is held
-at 
-<A HREF="http://www.sourceforge.net">Sourceforge</A>.  This means
-that it is possible to update your DXSpider installation to the latest
-sources by using a few simple commands.
-<P>
-<P>THIS IS NOT FOR THE FAINT HEARTED!!!  ONLY DO THIS IF YOU HAVE A TEST
-INSTALLATION OR ARE WILLING TO HAVE YOUR CLUSTER CRASH ON YOU!!!
-THIS MUST BE CONSIDERED AT LEAST BETA TESTING AND MAYBE EVEN ALPHA!!
-YOU HAVE BEEN WARNED!!!
-<P>
-<P>DID I MENTION..... ONLY DO THIS IF YOU ARE WILLING TO ACCEPT THE
-CONSEQUENCES!!!
-<P>
-<P>I am of course assuming that you have a machine with both DXSpider and
-Internet access running.
+<P>DXSpider deals seamlessly with standard AK1A type mail.  It supports both
+personal and bulletin mail and the sysop has additional commands to ensure
+that mail gets to where it is meant.  DXSpider will send mail almost
+immediately, assuming that the target is on line.  However, only one
+mail message is dealt with at any one time.  If a mail message is already
+being sent or recieved, then the new message will be queued until it has
+finished.
+<P>The cluster mail is automatically deleted after 30 days unless the sysop
+sets the "keep" flag using the <EM>msg</EM> command.
+<P>
+<H2><A NAME="ss9.1">9.1 Personal mail</A>
+</H2>
+
+<P>Personal mail is sent using the <EM>sp</EM> command.  This is actually the
+default method of sending mail and so a simple <EM>s</EM> for send will do.
+A full list of the send commands and options is in the <EM>command set</EM>
+section, so I will not duplicate them here.
 <P>
-<P>BEFORE YOU EVEN CONSIDER STARTING WITH THIS MAKE A BACKUP OF YOUR
-ENTIRE SPIDER TREE!!
+<H2><A NAME="ss9.2">9.2 Bulletin mail</A>
+</H2>
+
+<P>Bulletin mail is sent by using the <EM>sb</EM> command.  This is one of the
+most common mistakes users make when sending mail.  They send a bulletin
+mail with <EM>s</EM> or <EM>sp</EM> instead of <EM>sb</EM> and of course
+the message never leaves the cluster.  This can be rectified by the sysop
+by using the <EM>msg</EM> command.
 <P>
-<P>Assuming you are connected to the Internet, you need to login to the
-CVS repository and then update your Spider source.  There are several
-steps which are listed below ...
+<P>Bulletin addresses can be set using the Forward.pl file.
 <P>
-<P>First login as the user <EM>sysop</EM>.  Next you need to connect to the CVS
-repository.  You do this with the command below ...
+<H2><A NAME="ss9.3">9.3 Forward.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>
+<BLOCKQUOTE><CODE>
 <PRE>
-cvs -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/DXSpider login 
+#
+# 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) ],
+);
 </PRE>
-<P>You will get a password prompt.  Simply hit return here and your machine should
-return to a normal linux prompt.
+</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>What happens next depends on whether you have an existing installation that 
-you want to update with the latest and greatest or whether you just want
-to see what is there and/or run it on a new machine for testing.
-Either way you will want to change directory to a new place, if you want to
-update an existing installation then I suggest /tmp, otherwise choose a
-suitable place according to the normal installation instructions.
+<P>To force the cluster to reread the file use load/forward
 <P>
-<P>The next step will create a brand new 'spider' directory in your current
-directory.
 <P>
+<H2><A NAME="ss9.4">9.4 The msg command</A>
+</H2>
+
+<P>The <EM>msg</EM> command is a very powerful and flexible tool for the
+sysop.  It allows the sysop to alter to and from fields and make other
+changes to manage the cluster mail.
+<P>Here is a full list of the various options ...
+<P>
+<BLOCKQUOTE><CODE>
 <PRE>
-cvs -z3 -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/DXSpider co spider
+  MSG TO &lt;msgno> &lt;call>     - change TO callsign to &lt;call>
+  MSG FRom &lt;msgno> &lt;call>   - change FROM callsign to &lt;call>
+  MSG PRrivate &lt;msgno>      - set private flag
+  MSG NOPRrivate &lt;msgno>    - unset private flag
+  MSG RR &lt;msgno>            - set RR flag
+  MSG NORR &lt;msgno>          - unset RR flag
+  MSG KEep &lt;msgno>          - set the keep flag (message won't be deleted ever)
+  MSG NOKEep &lt;msgno>        - unset the keep flag
+  MSG SUbject &lt;msgno> &lt;new> - change the subject to &lt;new>
+  MSG WAittime &lt;msgno>      - remove any waiting time for this message
+  MSG NOREad &lt;msgno>        - mark message as unread
+  MSG REad &lt;msgno>          - mark message as read
+  MSG QUeue                 - queue any outstanding bulletins
+  MSG QUeue 1               - queue any outstanding private messages
 </PRE>
-<P>This command is all on one line.
-<P>
-<P>Hopefully your screen should show you downloading files.  The -z3 simply compresses
-the download to improve speed.
-When this has finished, you will have exactly the same as if you had untarred a full 
-tarball PLUS some extra directories and files that CVS needs to do the magic that 
-it does.
-<P>
-<P>Now if you are doing a new installation, that's it.  Carry on as if you have
-just downloaded and untarred the lastest tarball.
+</CODE></BLOCKQUOTE>
+<P>These commands are simply typed from within the cluster as the sysop user.
 <P>
-<P>If you want to upgrade your current installation then do this ...
+<H2><A NAME="ss9.5">9.5 Message status</A>
+</H2>
+
+<P>You can check on a message from within the cluster by using the command
+<EM>stat/msg</EM>.  This will give you additional information on the
+message number including which nodes have received it, which node it
+was received from and when etc.  Here is an example of the output of
+the command ...
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
-tar cvfz /tmp/s.tgz spider
-cd /
-tar xvfzp /tmp/s.tgz
+G0VGS de GB7MBC 28-Jan-2001 1308Z >
+stat/msg 6869
+        From: GB7DJK
+    Msg Time: 26-Jan-2001 1302Z
+       Msgno: 6869
+      Origin: GB7DJK
+        Size: 8012
+     Subject: AMSAT 2line KEPS 01025.AMSAT
+          To: UK
+Got it Nodes: GB7BAA, GB7ADX
+     Private: 0
+Read Confirm: 0
+  Times read: 0
+G0VGS de GB7MBC 28-Jan-2001 1308Z >
 </PRE>
 </CODE></BLOCKQUOTE>
-<P>This is assuming you downloaded to the /tmp directory of course.
-<P>
-<P>NOTE:  the 'p' on the end of the 'xvfz' is IMPORTANT!   It keeps the permissions
-correct.  YOU WERE LOGGED IN AS THE USER SYSOP WEREN'T YOU?????
-<P>Remember to recompile the C client (cd /spider/src; make)
 <P>
-<P>At this point the files have been upgraded.  You can (usually) restrt the cluster
-in your own time.  However, if you attempt to use any new commands or features
-expect it to be fatal!  At least your cluster will have been restarted then so it
-will be too late to worry about it!
+<H2><A NAME="ss9.6">9.6 Filtering mail</A>
+</H2>
+
+<P>This is described in the section on <EM>Other filters</EM> so I will not
+duplicate it here.
 <P>
-<P>Now the magic part!  From now on when you want to update, simply connect to the 
-Internet and then, as the user <EM>sysop</EM> ...
+<H2><A NAME="ss9.7">9.7 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.
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
-cd /spider
-cvs -z3 update -d
+qw(GB7TLH GB7DJK GB7DXM GB7CDX GB7BPQ GB7DXN GB7MBC GB7MBC-6 GB7MDX
+   GB7NDX GB7SDX GB7TDX GB7UDX GB7YDX GB7ADX GB7BAA GB7DXA GB7DXH 
+   GB7DXK GB7DXI GB7DXS)
 </PRE>
 </CODE></BLOCKQUOTE>
-<P>and your files will be updated.  As above, remember to recompile the "C" client 
-if it has been updated (CVS will tell you) and restart if any of the perl scripts
-have been altered or added, again, CVS will tell you.
+<P>Any mail sent to "sysop" would only be sent to the callsigns in this list.
 <P>
-<P>You will find any changes documented in the /spider/Changes file.
+<H2><A NAME="ss9.8">9.8 BBS interface</A>
+</H2>
+
+<P>Spider provides a simple BBS interface.  No input is required from the sysop
+of the cluster at all.  The BBS simply sets the cluster as a BBS and pushes
+any required mail to the cluster.  No mail can flow from Spider to the BBS,
+the interface is one-way.
+<P>
+<P>Please be careful not to flood the cluster network with unnecessary mail.
+Make sure you only send mail to the clusters that want it by using the
+Forward.pl file very carefully.
 <P>
 <HR>
 <A HREF="adminmanual-10.html">Next</A>