updated documentation a bit
[spider.git] / html / adminmanual-5.html
index 5fa2d87a4983a536b29a51ac4b59c5dadf03a159..1ad28e222ef3ad07c480609d8eee3ef8d9274120 100644 (file)
@@ -2,7 +2,7 @@
 <HTML>
 <HEAD>
  <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
- <TITLE>The DXSpider Administration Manual v1.47: Mail</TITLE>
+ <TITLE>The DXSpider Administration Manual v1.48: Databases</TITLE>
  <LINK HREF="adminmanual-6.html" REL=next>
  <LINK HREF="adminmanual-4.html" REL=previous>
  <LINK HREF="adminmanual.html#toc5" REL=contents>
 <A HREF="adminmanual-4.html">Previous</A>
 <A HREF="adminmanual.html#toc5">Contents</A>
 <HR>
-<H2><A NAME="s5">5. Mail</A></H2>
+<H2><A NAME="s5">5. Databases</A></H2>
 
-<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>Spider allows the creation of local or remote databases.  It supports
+chained databases, allowing several different databases to be scanned
+with one simple command.  Importing of databases is limited at present
+to the standard AK1A databases such as OBLAST and the DB0SDX QSL 
+database but will expand with time.
 <P>
-<H2><A NAME="ss5.1">5.1 Personal mail</A>
+<H2><A NAME="ss5.1">5.1 Creating databases</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>Creating a database could not be more simple.  All the commands are
+sent from the cluster prompt as the <EM>sysop</EM> user.
+<P>To create a database you use the command <EM>dbcreate</EM>.  It can
+be used in 3 different ways like so ..
 <P>
-<H2><A NAME="ss5.2">5.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>Bulletin addresses can be set using the Forward.pl file.
-<P>
-<H2><A NAME="ss5.3">5.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 ...
+<BLOCKQUOTE><CODE>
+<PRE>
+dbcreate &lt;name>
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>To simply create a database locally, you just tell the command the
+name of the database.  This does not create the actual database, it
+simply defines it to say that it exists.
 <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) ],
-);
+dbcreate &lt;name> chain &lt;name> [&lt;name>...]
 </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>This creates a chained database entry.  The first database will be
+scanned, then the second, the third etc...
 <P>
-<P>To force the cluster to reread the file use load/forward
+<BLOCKQUOTE><CODE>
+<PRE>
+dbcreate &lt;name> remote &lt;name>
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>This creates a remote entry.  the first name field is the database
+name at the remote node, then the remote switch, then the actual
+node_call of the remote node, for example...
 <P>
+<BLOCKQUOTE><CODE>
+<PRE>
+dbcreate buckmaster remote gb7dxc
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>Remote databases cannot be chained, however, the last database in a
+chain can be a remote database.
 <P>
-<H2><A NAME="ss5.4">5.4 The msg command</A>
+<H2><A NAME="ss5.2">5.2 Importing databases</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>The only databases that Spider can currently import are the standard
+AK1A databases such as OBLAST or the DB0SDX qsl and address database.
+This will be added to with time.
+<P>To import such a database, first put the file somewhere useful like /tmp
+and then issue the following command ...
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
-  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
+dbimport oblast /tmp/OBLAST.FUL
 </PRE>
 </CODE></BLOCKQUOTE>
-<P>These commands are simply typed from within the cluster as the sysop user.
+<P>This will update the existing local oblast database or create it if
+it does not exist.
 <P>
-<H2><A NAME="ss5.5">5.5 Message status</A>
+<H2><A NAME="ss5.3">5.3 Checking available databases</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>Once a database is created, you will want to check that it has been
+added.  To do this use the <EM>dbavail</EM> command.  This will
+output the available databases.  For example ...
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
-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 >
+dbavail
+DB Name          Location   Chain
+qsl              Local
+buck             GB7ADX
+hftest           GB7DXM
+G0VGS de GB7MBC  3-Feb-2001 1925Z >
 </PRE>
 </CODE></BLOCKQUOTE>
 <P>
-<H2><A NAME="ss5.6">5.6 Filtering mail</A>
+<H2><A NAME="ss5.4">5.4 Looking up databases</A>
 </H2>
 
-<P>This is described in the section on <EM>Other filters</EM> so I will not
-duplicate it here.
+<P>To look for information in a defined database, simply use the <EM>dbshow</EM>
+command, for example ...
 <P>
-<H2><A NAME="ss5.7">5.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.
+<BLOCKQUOTE><CODE>
+<PRE>
+dbshow buckmaster G0YLM
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>will show the information for the callsign G0YLM from the buckmaster
+database if it exists.  To make things more standard for the users
+you can add an entry in the Aliases file so that it looks like a standard 
+<EM>show</EM> command like this ...
 <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)
+'^sh\w*/buc', 'dbshow buckmaster', 'dbshow',
 </PRE>
 </CODE></BLOCKQUOTE>
-<P>Any mail sent to "sysop" would only be sent to the callsigns in this list.
+<P>Now you can simply use show/buckmaster or an abreviation.
 <P>
-<H2><A NAME="ss5.8">5.8 BBS interface</A>
+<H2><A NAME="ss5.5">5.5 Removing databases</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>To delete an existing database you use the <EM>dbremove</EM> command.
+For example ...
 <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.
+<BLOCKQUOTE><CODE>
+<PRE>
+dbremove oblast
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>would remove the oblast database and its associated datafile from the
+system.  There are no warnings or recovery possible from this command.
+If you remove a database it ceases to exist and would have to be created
+from scratch if you still required it.
 <P>
 <HR>
 <A HREF="adminmanual-6.html">Next</A>