updated documentation a bit
[spider.git] / html / adminmanual-4.html
index 48e5702a0d5f5567ffe489adbbb9908391a59be7..37ff648b53ad8efaf2a2bd64c8a4b50cff9364ab 100644 (file)
@@ -2,7 +2,7 @@
 <HTML>
 <HEAD>
  <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
- <TITLE>The DXSpider Administration Manual v1.47: Other filters</TITLE>
+ <TITLE>The DXSpider Administration Manual v1.48: Scripts</TITLE>
  <LINK HREF="adminmanual-5.html" REL=next>
  <LINK HREF="adminmanual-3.html" REL=previous>
  <LINK HREF="adminmanual.html#toc4" REL=contents>
 <A HREF="adminmanual-3.html">Previous</A>
 <A HREF="adminmanual.html#toc4">Contents</A>
 <HR>
-<H2><A NAME="s4">4. Other filters</A></H2>
+<H2><A NAME="s4">4. Scripts</A></H2>
 
-<H2><A NAME="ss4.1">4.1 Filtering Mail</A>
-</H2>
-
-<P>In the /spider/msg directory you will find a file called badmsg.pl.issue.  Rename
-this to badmsg.pl and edit the file.  The original looks something like this ....
-<P>
-<BLOCKQUOTE><CODE>
-<PRE>
-
-# 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
-
-# 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
-
-
-
-package DXMsg;
-
-@badmsg = (
-'B',    'T',    'SALE', 
-'B',    'T',    'WANTED',
-'B',    'S',    'WANTED',
-'B',    'S',    'SALE', 
-'B',    'S',    'WTB',
-'B',    'S',    'WTS',
-'B',    'T',    'FS',
-);
-</PRE>
-</CODE></BLOCKQUOTE>
+<P>From 1.48 onwards it will become increasingly possible to control DXSpider's
+operation with scripts of various kinds.
 <P>
-<P>I think this is fairly self explanatory.  It is simply a list of subject 
-headers that we do not want to pass on to either the users of the cluster or 
-the other cluster nodes that we are linked to.  This is usually because of 
-rules and regulations pertaining to items for sale etc in a particular country.
+<P>In the first instance, in 1.48, the sysop can create, with their favorite 
+text editor, files in the directory <EM>/spider/scripts</EM> which contain
+any legal command for a callsign or class of connection which will be executed
+at logon.
 <P>
-<H2><A NAME="ss4.2">4.2 Filtering DX callouts (Depricated)</A>
-</H2>
-
-<P><B><I>From version 1.47, this method is replaced by the command set/baddx</I></B>
+<P> 
+The filename are the callsign of the connection that you want the script to 
+operate on, eg: <EM>/spider/scripts/g1tlh</EM>. The filenames are always in 
+lower case on those architectures where this makes a difference.
 <P>
-<P>In the same way as mail, there are some types of spot we do not wish to pass on 
-to users or linked cluster nodes.  In the /spider/data directory you will find 
-a file called baddx.pl.issue.  Rename this to baddx.pl and edit the file.  The
-original looks like this ....
+<P>In addition to the callsign specific scripts there are three others:-
 <P>
 <BLOCKQUOTE><CODE>
 <PRE>
-
-# the list of dx spot addresses that we don't store and don't pass on
-
-
-package DXProt;
-
-@baddx = qw 
-
- FROG 
- SALE
- FORSALE
- WANTED
- P1RATE
- PIRATE
- TEST
- DXTEST
- NIL
- NOCALL 
-);
+startup
+user_default
+node_default
 </PRE>
 </CODE></BLOCKQUOTE>
+<P>The <EM>startup</EM> script is executed immediately after all
+initialisation of the node is done, but before any connections are
+possible.
 <P>
-<P>Again, this is simply a list of names we do not want to see in the spotted 
-field of a DX callout.
+<P>The <EM>user_default</EM> script is executed for every user that does
+<B>NOT</B> already have a specific script.
 <P>
+<P>The <EM>node_default</EM> script is executed for every node that doesn't
+have a specific script.
 <P>
-<H2><A NAME="ss4.3">4.3 Filtering words from text fields in Announce, Talk and DX spots</A>
-</H2>
-
-<P>Create a file in /spider/data called <EM>badwords</EM>.  The format is quite
-simple.  Lines beginning with # are ignored so comments can be added.  An
-example file is below ...
-<P>
-<BLOCKQUOTE><CODE>
-<PRE>
-# Below is a list of words we do not wish to see on the cluster
-grunge grunged grunging
-splodge splodger splodging
-grince
-fluffle
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>Multiple words can be used on the same line as shown.  Obviously these
-are just examples :-)
-<P>
-<P>You can reload the file from the cluster prompt as sysop with load/badwords.
+<P>There are a couple of examples in the <EM>/spider/scripts</EM> directory.
 <P>
 <HR>
 <A HREF="adminmanual-5.html">Next</A>