updated documentation a bit
[spider.git] / html / adminmanual-2.html
index b2418ea6e7c73d7ba776408b5b99fc8155f8b563..25afaa266e8f6f55fb39b346a5924fafd611bf2f 100644 (file)
 <HTML>
 <HEAD>
  <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
- <TITLE>The DXSpider Installation and Administration Manual : The Client program</TITLE>
+ <TITLE>The DXSpider Administration Manual v1.48: Other filters</TITLE>
  <LINK HREF="adminmanual-3.html" REL=next>
  <LINK HREF="adminmanual-1.html" REL=previous>
  <LINK HREF="adminmanual.html#toc2" REL=contents>
+<link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
 </HEAD>
 <BODY>
 <A HREF="adminmanual-3.html">Next</A>
 <A HREF="adminmanual-1.html">Previous</A>
 <A HREF="adminmanual.html#toc2">Contents</A>
 <HR>
-<H2><A NAME="s2">2. The Client program</A></H2>
+<H2><A NAME="s2">2. Other filters</A></H2>
 
-<P>In earlier versions of Spider, all the processes were Perl scripts.  This was fine but with a lot of users your computer 
-memory would soon be used up.  To combat this a new client was written in "C".  This client only works for <EM>incoming</EM> 
-connects at the moment.  Before you can use it though it has to be "made".  CD to /spider/src and type <EM>make</EM>.  You 
-should see the output on your screen and hopefully now have a small C program called <EM>client</EM>.  Leave it in this 
-directory.
+<H2><A NAME="ss2.1">2.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>
+<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>
+<P>
+<H2><A NAME="ss2.2">2.2 Filtering words from text fields in Announce, Talk and DX spots</A>
+</H2>
+
+<P>From version 1.48 onwards the interface to this has changed. You can now
+use the commands <EM>set/badword</EM> to add words that you are not prepared
+to see on the cluster, <EM>unset/badword</EM> to allow that word again and 
+<EM>show/badword</EM> to list the words that you have set.
+<P>
+<P>If you have a previous <EM>/spider/data/badwords</EM>, the first time you start
+the node, it will read and convert this file to the new commands. The old style
+file will then be removed.
+<P>
+<H2><A NAME="ss2.3">2.3 Stopping (possibly bad) DX Spots from Nodes or Spotters</A>
+</H2>
+
+<P> 
+There are a number of commands that control whether a spot progresses
+any further by regarding it as "bad" in some way.
+<P>
+<P>A DX Spot has a number of fields which can checked to see whether they
+contain "bad" values, they are: the DX callsign itself, the Spotter and
+the Originating Node.
+<P>
+<P>There are a set of commands which allow the sysop to control whether a
+spot continues:-
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+set/baddx
+set/badspotter
+set/badnode
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>These work in the same as the <EM>set/badword</EM> command, you can add
+any words or callsigns or whatever to the appropriate database. For
+example, to stop a spot from a particular node you do:
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+set/badnode gb7djk gb7dxc
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>a bad spotter:
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+set/badspotter b0mb p1rat nocall
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>and some bad dx:
+<P>
+<BLOCKQUOTE><CODE>
+<PRE>
+set/baddx video wsjt
+</PRE>
+</CODE></BLOCKQUOTE>
+<P>You can remove a word using the appropriate unset command
+(<EM>unset/baddx, unset/badspotter, unset/badnode</EM>) or list them
+using one of <EM>show/baddx, show/badspotter</EM> and
+<EM>show/badnode</EM>.
 <P>
 <HR>
 <A HREF="adminmanual-3.html">Next</A>