updated documentation a bit
[spider.git] / html / adminmanual-2.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2 <HTML>
3 <HEAD>
4  <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
5  <TITLE>The DXSpider Administration Manual v1.48: Other filters</TITLE>
6  <LINK HREF="adminmanual-3.html" REL=next>
7  <LINK HREF="adminmanual-1.html" REL=previous>
8  <LINK HREF="adminmanual.html#toc2" REL=contents>
9 <link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
10 </HEAD>
11 <BODY>
12 <A HREF="adminmanual-3.html">Next</A>
13 <A HREF="adminmanual-1.html">Previous</A>
14 <A HREF="adminmanual.html#toc2">Contents</A>
15 <HR>
16 <H2><A NAME="s2">2. Other filters</A></H2>
17
18 <H2><A NAME="ss2.1">2.1 Filtering Mail</A>
19 </H2>
20
21 <P>In the /spider/msg directory you will find a file called badmsg.pl.issue.  Rename
22 this to badmsg.pl and edit the file.  The original looks something like this ....
23 <P>
24 <BLOCKQUOTE><CODE>
25 <PRE>
26
27 # the list of regexes for messages that we won't store having
28 # received them (bear in mind that we must receive them fully before
29 # we can bin them)
30
31
32 # The format of each line is as follows
33
34 #     type      source             pattern 
35 #     P/B/F     T/F/O/S            regex  
36
37 # type: P - private, B - bulletin (msg), F - file (ak1a bull)
38 # source: T - to field, F - from field,  O - origin, S - subject 
39 # pattern: a perl regex on the field requested
40
41 # Currently only type B and P msgs are affected by this code.
42
43 # The list is read from the top down, the first pattern that matches
44 # causes the action to be taken.
45
46 # The pattern can be undef or 0 in which case it will always be selected
47 # for the action specified
48
49
50
51 package DXMsg;
52
53 @badmsg = (
54 'B',    'T',    'SALE', 
55 'B',    'T',    'WANTED',
56 'B',    'S',    'WANTED',
57 'B',    'S',    'SALE', 
58 'B',    'S',    'WTB',
59 'B',    'S',    'WTS',
60 'B',    'T',    'FS',
61 );
62 </PRE>
63 </CODE></BLOCKQUOTE>
64 <P>
65 <P>I think this is fairly self explanatory.  It is simply a list of subject 
66 headers that we do not want to pass on to either the users of the cluster or 
67 the other cluster nodes that we are linked to.  This is usually because of 
68 rules and regulations pertaining to items for sale etc in a particular country.
69 <P>
70 <P>
71 <H2><A NAME="ss2.2">2.2 Filtering words from text fields in Announce, Talk and DX spots</A>
72 </H2>
73
74 <P>From version 1.48 onwards the interface to this has changed. You can now
75 use the commands <EM>set/badword</EM> to add words that you are not prepared
76 to see on the cluster, <EM>unset/badword</EM> to allow that word again and 
77 <EM>show/badword</EM> to list the words that you have set.
78 <P>
79 <P>If you have a previous <EM>/spider/data/badwords</EM>, the first time you start
80 the node, it will read and convert this file to the new commands. The old style
81 file will then be removed.
82 <P>
83 <H2><A NAME="ss2.3">2.3 Stopping (possibly bad) DX Spots from Nodes or Spotters</A>
84 </H2>
85
86 <P> 
87 There are a number of commands that control whether a spot progresses
88 any further by regarding it as "bad" in some way.
89 <P>
90 <P>A DX Spot has a number of fields which can checked to see whether they
91 contain "bad" values, they are: the DX callsign itself, the Spotter and
92 the Originating Node.
93 <P>
94 <P>There are a set of commands which allow the sysop to control whether a
95 spot continues:-
96 <P>
97 <BLOCKQUOTE><CODE>
98 <PRE>
99 set/baddx
100 set/badspotter
101 set/badnode
102 </PRE>
103 </CODE></BLOCKQUOTE>
104 <P>These work in the same as the <EM>set/badword</EM> command, you can add
105 any words or callsigns or whatever to the appropriate database. For
106 example, to stop a spot from a particular node you do:
107 <P>
108 <BLOCKQUOTE><CODE>
109 <PRE>
110 set/badnode gb7djk gb7dxc
111 </PRE>
112 </CODE></BLOCKQUOTE>
113 <P>a bad spotter:
114 <P>
115 <BLOCKQUOTE><CODE>
116 <PRE>
117 set/badspotter b0mb p1rat nocall
118 </PRE>
119 </CODE></BLOCKQUOTE>
120 <P>and some bad dx:
121 <P>
122 <BLOCKQUOTE><CODE>
123 <PRE>
124 set/baddx video wsjt
125 </PRE>
126 </CODE></BLOCKQUOTE>
127 <P>You can remove a word using the appropriate unset command
128 (<EM>unset/baddx, unset/badspotter, unset/badnode</EM>) or list them
129 using one of <EM>show/baddx, show/badspotter</EM> and
130 <EM>show/badnode</EM>.
131 <P>
132 <HR>
133 <A HREF="adminmanual-3.html">Next</A>
134 <A HREF="adminmanual-1.html">Previous</A>
135 <A HREF="adminmanual.html#toc2">Contents</A>
136 </BODY>
137 </HTML>