Added helpfile for forward/latlong and updated admin manual. Resolved
[spider.git] / html / adminmanual-8.html
index 8fe2eb17d6423be266ca219ce5fc55af74fa39df..684c8176a56722615f5b656f1f0810e240e551b4 100644 (file)
@@ -2,7 +2,7 @@
 <HTML>
 <HEAD>
  <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
- <TITLE>The DXSpider Installation and Administration Manual : Information, files and useful programs</TITLE>
+ <TITLE>The DXSpider Installation and Administration Manual : Other filters</TITLE>
  <LINK HREF="adminmanual-9.html" REL=next>
  <LINK HREF="adminmanual-7.html" REL=previous>
  <LINK HREF="adminmanual.html#toc8" REL=contents>
 <A HREF="adminmanual-7.html">Previous</A>
 <A HREF="adminmanual.html#toc8">Contents</A>
 <HR>
-<H2><A NAME="s8">8. Information, files and useful programs</A></H2>
+<H2><A NAME="s8">8. Other filters</A></H2>
 
-<H2><A NAME="ss8.1">8.1 MOTD</A>
+<H2><A NAME="ss8.1">8.1 Filtering Mail</A>
 </H2>
 
-<P>One of the more important things a cluster sysop needs to do is to get 
-information to his users.  The simplest way to do this is to have a banner 
-that is sent to the user on login.  This is know as a "message of the day" 
-or "motd".  To set this up, simply create a file in /spider/data called motd 
-and edit it to say whatever you want.  It is purely a text file and will be 
-sent automatically to anyone logging in to the cluster.
-<P>
-<H2><A NAME="ss8.2">8.2 Downtime message</A>
-</H2>
-
-<P>If for any reason the cluster is down, maybe for upgrade or maintenance but 
-the machine is still running, a message can be sent to the user advising them 
-of the fact.  This message lives in the /spider/data directory and is called
-"offline".  Simply create the file and edit it to say whatever you wish.  
-This file will be sent to a user attempting to log into the cluster when
-DXSpider is not actually running.
-<P>
-<H2><A NAME="ss8.3">8.3 Other text messages</A>
-</H2>
-
-<P>You can set other text messages to be read by the user if they input the file 
-name.  This could be for news items or maybe information for new users.  
-To set this up, make a directory under /spider called <EM>packclus</EM>.  
-Under this directory you can create files called <EM>news</EM> or <EM>newuser</EM>
-for example.  In fact you can create files with any names you like.  These can 
-be listed by the user with the command ....
-<P>
-<BLOCKQUOTE><CODE>
-<PRE>
-show/files
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>They can be read by the user by typing the command ....
-<P>
-<BLOCKQUOTE><CODE>
-<PRE>
-type news
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>If the file they want to read is called <EM>news</EM>.  You could also set 
-an alias for this in the Alias file to allow them just to type <EM>news</EM>
-<P>
-<P>You can also store other information in this directory, either directly or 
-nested under directories.  One use for this would be to store DX bulletins 
-such as the OPDX bulletins.  These can be listed and read by the user.  
-To keep things tidy, make a directory under /spider/packclus called
-<EM>bulletins</EM>.  Now copy any OPDX or similar bulletins into it.  These 
-can be listed by the user in the same way as above using the <EM>show/files</EM>
-command with an extension for the bulletins directory you have just created, 
-like this ....
-<P>
-<BLOCKQUOTE><CODE>
-<PRE>
-show/files bulletins
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>
-<P>An example would look like this ....
-<P>
-<BLOCKQUOTE><CODE>
-<PRE>
-sh/files
-bulletins      DIR 20-Dec-1999 1715Z news          1602 14-Dec-1999 1330Z
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>You can see that in the files area (basically the packclus directory) there is a 
-file called <EM>news</EM> and a directory called <EM>bulletins</EM>.  You can 
-also see that dates they were created.  In the case of the file <EM>news</EM>, 
-you can also see the time it was last modified, a good clue as to whether the 
-file has been updated since you last read it.  To read the file called 
-<EM>news</EM> you would simply issue the command ....
-<P>
-<BLOCKQUOTE><CODE>
-<PRE>
-type news
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>To look what is in the bulletins directory you issue the command ....
-<P>
-<BLOCKQUOTE><CODE>
-<PRE>
-show/files bulletins
-opdx390      21381 29-Nov-1999 1621Z opdx390.1     1670 29-Nov-1999 1621Z
-opdx390.2     2193 29-Nov-1999 1621Z opdx391      25045 29-Nov-1999 1621Z  
-opdx392      35969 29-Nov-1999 1621Z opdx393      15023 29-Nov-1999 1621Z  
-opdx394      33429 29-Nov-1999 1621Z opdx394.1     3116 29-Nov-1999 1621Z  
-opdx395      24319 29-Nov-1999 1621Z opdx396      32647 29-Nov-1999 1621Z
-opdx396.1     5537 29-Nov-1999 1621Z opdx396.2     6242 29-Nov-1999 1621Z
-opdx397      18433 29-Nov-1999 1621Z opdx398      19961 29-Nov-1999 1621Z  
-opdx399      17719 29-Nov-1999 1621Z opdx400      19600 29-Nov-1999 1621Z
-opdx401      27738 29-Nov-1999 1621Z opdx402      18698 29-Nov-1999 1621Z
-opdx403      24994 29-Nov-1999 1621Z opdx404      15685 29-Nov-1999 1621Z
-opdx405      13984 29-Nov-1999 1621Z opdx405.1     4166 29-Nov-1999 1621Z
-opdx406      28934 29-Nov-1999 1621Z opdx407      24153 29-Nov-1999 1621Z
-opdx408      15081 29-Nov-1999 1621Z opdx409      23234 29-Nov-1999 1621Z
-Press Enter to continue, A to abort (16 lines) >
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>You can now read any file in this directory using the type command, like this ....
+<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>
-type bulletins/opdx391
-Ohio/Penn DX Bulletin No. 391
-The Ohio/Penn Dx PacketCluster
-DX Bulletin No. 391
-BID: $OPDX.391
-January 11, 1999
-Editor Tedd Mirgliotta, KB8NW
-Provided by BARF-80 BBS Cleveland, Ohio
-Online at 440-237-8208 28.8k-1200 Baud 8/N/1 (New Area Code!)
-Thanks to the Northern Ohio Amateur Radio Society, Northern Ohio DX
-Association, Ohio/Penn PacketCluster Network, K1XN &amp; Golist, WB2RAJ/WB2YQH
-&amp; The 59(9) DXReport, W3UR &amp; The Daily DX, K3TEJ, KN4UG, W4DC, NC6J, N6HR,
-Press Enter to continue, A to abort (508 lines) >
-</PRE>
-</CODE></BLOCKQUOTE>
-<P>The page length will of course depend on what you have it set to!
-<P>
-<H2><A NAME="ss8.4">8.4 The Aliases file</A>
-</H2>
 
-<P>You will find a file in /spider/cmd/ called Aliases.  First, copy this file to
-/spider/local_cmd/Aliases and edit this file.  You will see 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)
 
-#!/usr/bin/perl
 
-# provide some standard aliases for commands for terminally
-# helpless ak1a user (helpless in the sense that they never
-# read nor understand help files)
+# The format of each line is as follows
 
-# This file is automagically reloaded if its modification time is 
-# later than the one stored in CmdAlias.pm
+#     type      source             pattern 
+#     P/B/F     T/F/O/S            regex  
 
-# PLEASE make this file consistant with reality! (the patterns MUST
-# match the filenames!)
+# 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
 
-# Don't alter this file, copy it into the local_cmd tree and modify it.
-# This file will be replaced everytime I issue a new release.
+# 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.
 
-# You only need to put aliases in here for commands that don't work as
-# you desire naturally, e.g sh/dx on its own just works as you expect
-# so you need not add it as an alias.
+# The pattern can be undef or 0 in which case it will always be selected
+# for the action specified
 
 
 
-package CmdAlias;
+package DXMsg;
 
-%alias = (
-    '?' => [
-          '^\?', 'apropos', 'apropos',
-        ],
-    'a' => [
-          '^ann.*/full', 'announce full', 'announce', 
-          '^ann.*/sysop', 'announce sysop', 'announce',
-          '^ann.*/(.*)$', 'announce $1', 'announce',
-        ],
-        'b' => [
-        ],
-        'c' => [
-        ],
-        'd' => [
-          '^del', 'kill', 'kill',
-          '^del\w*/fu', 'kill full', 'kill',
-          '^di\w*/a\w*', 'directory all', 'directory',
-          '^di\w*/b\w*', 'directory bulletins', 'directory',
-          '^di\w*/n\w*', 'directory new', 'directory',
-          '^di\w*/o\w*', 'directory own', 'directory',
-          '^di\w*/s\w*', 'directory subject', 'directory',
-          '^di\w*/t\w*', 'directory to', 'directory',
-          '^di\w*/f\w*', 'directory from', 'directory',
-          '^di\w*/(\d+)', 'directory $1', 'directory',
-        ],
-        'e' => [
-        ],
-        'f' => [
-        ],
-        'g' => [
-        ],
-        'h' => [
-        ],
-        'i' => [
-        ],
-        'j' => [
-        ],
-        'k' => [
-        ],
-        'l' => [
-          '^l$', 'directory', 'directory',
-          '^ll$', 'directory', 'directory',
-          '^ll/(\d+)', 'directory $1', 'directory',
-        ],
-        'm' => [
-        ],
-        'n' => [
-          '^news', 'type news', 'type',
-        ],
-        'o' => [
-        ],
-        'p' => [
-        ],
-        'q' => [
-          '^q', 'bye', 'bye',
-        ],
-        'r' => [        
-          '^r$', 'read', 'read',
-          '^rcmd/(\S+)', 'rcmd $1', 'rcmd',
-        ],
-        's' => [
-          '^s/p$', 'send', 'send',
-          '^sb$', 'send noprivate', 'send',
-          '^set/home$', 'set/homenode', 'set/homenode',
-          '^set/nobe', 'unset/beep', 'unset/beep',
-          '^set/nohe', 'unset/here', 'unset/here',
-          '^set/noan', 'unset/announce', 'unset/announce',
-          '^set/nodx', 'unset/dx', 'unset/dx',
-          '^set/nota', 'unset/talk', 'unset/talk',
-          '^set/noww', 'unset/wwv', 'unset/wwv',
-          '^set/nowx', 'unset/wx', 'unset/wx',
-          '^sh$', 'show', 'show',
-          '^sh\w*/buck', 'dbshow buck', 'dbshow',
-          '^sh\w*/bu', 'show/files bulletins', 'show/files',
-          '^sh\w*/c/n', 'show/configuration nodes', 'show/configuration',
-          '^sh\w*/c$', 'show/configuration', 'show/configuration',
-          '^sh\w*/com', 'dbavail', 'dbavail',
-          '^sh\w*/dx/(\d+)-(\d+)', 'show/dx $1-$2', 'show/dx',
-          '^sh\w*/dx/(\d+)', 'show/dx $1', 'show/dx',
-          '^sh\w*/dx/d(\d+)', 'show/dx from $1', 'show/dx',
-          '^sh\w*/email', 'dbshow email', 'dbshow',
-          '^sh\w*/hftest', 'dbshow hftest', 'dbshow',
-          '^sh\w*/vhftest', 'dbshow vhftest', 'dbshow',
-          '^sh\w*/qsl', 'dbshow qsl', 'dbshow',
-          '^sh\w*/tnc', 'who', 'who',
-          '^sh\w*/up', 'show/cluster', 'show/cluster',
-          '^sh\w*/w\w*/(\d+)-(\d+)', 'show/wwv $1-$2', 'show/wwv',
-          '^sh\w*/w\w*/(\d+)', 'show/wwv $1', 'show/wwv',
-          '^sp$', 'send', 'send',
-        
-    ],
-        't' => [
-          '^ta$', 'talk', 'talk',
-          '^t$', 'talk', 'talk',
-        ],
-        'u' => [
-        ],
-        'v' => [
-        ],
-        'w' => [
-          '^wx/full', 'wx full', 'wx',
-          '^wx/sysop', 'wx sysop', 'wx',
-        ],
-        'x' => [
-        ],
-        'y' => [
-        ],
-        'z' => [
-        ],
-)
+@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>You can create aliases for commands at will.  Beware though, these may not 
-always turn out as you think.  Care is needed and you need to test the 
-results once you have set an alias.
 <P>
-<H2><A NAME="ss8.5">8.5 Forward.pl</A>
+<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>
+<H2><A NAME="ss8.2">8.2 Filtering DX callouts</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>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>
 <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;
+# the list of dx spot addresses that we don't store and don't pass on
+
+
+package DXProt;
+
+@baddx = qw 
 
-@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) ],
+ FROG 
+ SALE
+ FORSALE
+ WANTED
+ P1RATE
+ PIRATE
+ TEST
+ DXTEST
+ NIL
+ NOCALL 
 );
 </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>
-<P>To force the cluster to reread the file use load/forward
+<P>Again, this is simply a list of names we do not want to see in the spotted 
+field of a DX callout.
 <P>
-<H2><A NAME="ss8.6">8.6 Distribution lists</A>
+<P>
+<H2><A NAME="ss8.3">8.3 Filtering words from text fields in Announce, Talk and DX spots</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>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>
-qw(GB7TLH GB7DJK GB7DXM GB7CDX GB7BPQ GB7DXN GB7MBC GB7MBC-6 GB7MDX
-   GB7NDX GB7SDX GB7TDX GB7UDX GB7YDX GB7ADX GB7BAA GB7DXA GB7DXH 
-   GB7DXK GB7DXI GB7DXS)
+# 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>Any mail sent to "sysop" would only be sent to the callsigns in this list.
-<P>
-<H2><A NAME="ss8.7">8.7 Console.pl</A>
-</H2>
-
-<P>In later versions of Spider a simple console program is provided for the sysop.  
-This has a type ahead buffer with line editing facilities and colour for spots,
-announces etc.  To use this program, simply use console.pl instead of client.pl.
+<P>Multiple words can be used on the same line as shown.  Obviously these
+are just examples :-)
 <P>
-<P>To edit the colours, copy /spider/perl/Console.pl to /spider/local and edit the 
-file with your favourite editor.
+<P>You can reload the file from the cluster prompt as sysop with load/badwords.
 <P>
 <HR>
 <A HREF="adminmanual-9.html">Next</A>