Added allow_to in domain; Added include; Update docs; Fixed folding header lines

1 files changed, 60 insertions, 16 deletions

diff --git a/doc/INSTRUCTION b/doc/INSTRUCTION
index 40d91b1..1ac9e8e 100644
--- a/doc/INSTRUCTION
+++ b/doc/INSTRUCTION
@@ -2,7 +2,9 @@
 Usage
 =====
 
-    kbs
+    kbs [config-file]
+
+If config-file is not provided, a default of $HOME/.kbsrc is used.
 
 
 Description
@@ -16,11 +18,13 @@ a special keyword in a subject header to be used.
 Config file format
 ==================
 
-The kbs config file is read from $HOME/.kbsrc and has sections in the suggested
-order:
+The kbs config file is read from $HOME/.kbsrc (or the parameter supplied) and
+has sections in the suggested order:
 
 [config settings]
 
+[include]
+
 [trusted settings]
 
 [blacklist settings]
@@ -29,7 +33,7 @@ order:
 
 [domain settings]
 
-It is *highly* recommended to set .kbsrc to be only readable by the user - this
+It is *stringly* suggested to set .kbsrc to be only readable by the user - this
 is as passwords are stored in there.
 
 Blank lines and text proceeded with a hash (#) are ignored.
@@ -39,7 +43,7 @@ includes spaces, simple quote them (with either single or double quotes).
 
 Escapes aren't used (to make regular expression writing easier), so if you want
 to include a quote in a string, simply use the other sort of quote.  If you
-want both, sorry, you're stuck!
+want both, sorry!
 
 To see an example kbsrc file, see kbsrc in the src directory.
 
@@ -98,7 +102,10 @@ And understand the following variables:
 
     blockhtml <on|off>	Whether messages that are pure HTML (content part just
     			reported as "text/html" are blocked.  Also blocks
-			messages with an empty, or missing, content type.
+			messages with an empty, or missing, content type
+			WARNING: this will delete mail sent with old command
+			line mailers as they don't set a content-type - however,
+			plenty of spam has no valid content-type either.
 			Defaults to off.
 
     testmode <on|off>	Whether things will be really deleted, or just
@@ -109,6 +116,33 @@ And understand the following variables:
 			(or too easy for that matter).
 
 
+Include files
+=============
+
+Include files are useful if you want to scan multiple hosts buy using mutiple
+config files, eg.
+
+In file 1:
+
+set host	host1
+set username	user1
+set password	pass1
+
+include "/etc/kbsrc"
+
+
+In file 2:
+
+set host	host2
+set username	user2
+set password	pass2
+
+include "/etc/kbsrc"
+
+
+Then put all your rules as needed in /etc/kbsrc.
+
+
 Trusted settings
 ================
 
@@ -191,6 +225,7 @@ will be used.
     {
 	[default block|allow]
     	[block_user <username>]
+	[allow_to <regular expression>]
     	[allow_subject <regular expression>]
 	[block_subject <regular expression>]
     }
@@ -202,6 +237,13 @@ The block user allows a specific username to be blocked.  For instance, I've
 noticed that spammers have a great love of emailing from your username at
 a different domain.
 
+The allow_to sets a regular expression that the 'To: ' line in the header
+data must match.  This can be handy as for some reason, even though spam may
+be directed to your inbox, the 'To:' line will actually read a nonsense name
+for your host.  Note that it's not recommended to anchor the regular expression
+as if the mail has been sent to multiple recipients it is not guaranteed
+where your name will appear in the list of users.
+
 The allow_subject means that subjects that match that regular expression are
 always let through.
 
@@ -213,17 +255,19 @@ Multiple allow and block commands can be in one domain.
 The commands inside a domain can appear in any order, but the checks are always
 done in this order:
 
-1. If a trusted domain, allow message.
-2. If a trusted user, allow message.
-3. If an HTML message and these are blocked, delete message.
-4. If the domain is blacklisted, delete message.
-5. If the domain is not matched in a domain command, allow message.
-6. If the subject is allowed for the domain, allow message.
-7. If the username is blocked for the domain, delete message.
-8. If the subject is disallowed for the domain, delete message.
-9. Delete the message if the default is to block, otherwise allow.
+ 1. If a trusted domain, allow message.
+ 2. If a trusted user, allow message.
+ 3. If an HTML message and these are blocked, delete message.
+ 4. If the domain is blacklisted, delete message.
+ 5. If the domain is not matched in a domain command, allow message.
+ 6. If the subject is allowed for the domain, allow message.
+ 7. If an allow_to has been set for the domain, and it doesn't match,
+    delete message.
+ 8. If the username is blocked for the domain, delete message.
+ 9. If the subject is disallowed for the domain, delete message.
+10. Delete the message if the default is to block, otherwise allow.
 
 
 
 -------------------------------------------------------------------------------
-$Id: INSTRUCTION,v 1.6 2004-01-01 01:25:04 ianc Exp $
+$Id: INSTRUCTION,v 1.7 2004-01-26 02:01:49 ianc Exp $