new version changelog start

[pkg/t-prot.git] / t-prot.1

diff --git a/t-prot.1 b/t-prot.1
index 6ee7930727251d10e14bac30e7e86d181154351e..2be9fab2c8abad00d720cd2f4d1ba241abae555d 100644 (file)
--- a/t-prot.1
+++ b/t-prot.1
@@ -1,6 +1,6 @@
-.\" $Id: t-prot.1,v 1.178 2010/03/06 01:31:33 jochen Exp $
+.\" $Id: t-prot.1,v 1.184 2010/07/01 15:58:23 jochen Exp $
 .\"
-.TH T-PROT "1" "March 2010" "T-PROT"
+.TH T-PROT "1" "July 2010" "T-PROT"
 .SH NAME
 t-prot \- TOFU Protection - Display Filter for RFC 5322 messages
 .SH SYNOPSIS
@@ -25,15 +25,17 @@ initially designed to cope with the output of the MUA mutt (which
 is the reason for not using standard CPAN modules for handling
 messages).
 .PP
-For easy usage, you can include the file muttrc.t\-prot in your
-~/.muttrc. Also coming with the t-prot package is the example S-Lang
-macro t\-prot.sl for using t-prot from within slrn. There is a
-proof\-of\-concept filter for INN2, which you will have to adapt to
-the needs of the news site you host (please see the file for details).
+T\-prot offers example configuration files for mutt, Heirloom mailx
+and metamail. Also coming with the t-prot package is the example
+S-Lang macro t\-prot.sl for using t-prot from within slrn. There is
+a proof\-of\-concept filter for INN2, which you will have to adapt
+to the needs of the news site you host. For use with sendmail's
+alias(5) file, please see below (the option
+.BR "\-p" " provides an example line)."
 .SH OPTIONS
 .PP
 If you do not specify any options, t\-prot does ... nothing. Every
-feature you want must be turned on explicitely.
+feature you want must be turned on explicitly.
 Admittedly, we have quite a number of options for t\-prot. To limit
 confusion they are grouped into five sections: Input/Output Options,
 Advertisement And Mailing List Footers, Filtering Options, Detection
@@ -71,7 +73,9 @@ and should NEVER be used as a default, otherwise it will probably turn into
 a security issue.)
 .sp
 You can use this option safely to enable
-.BR "\-o" " /dev/null."
+.B "\-o"
+/dev/null (or other files which cannot be changed with the user's
+privileges).
 .TP
 .BR "\-\-max\-lines" =x
 Maximum number of lines a message may count (with headers). If the message
@@ -199,6 +203,14 @@ prey for
 Squeezes a sequence of four or more dots, exclamation marks, or question marks
 to only three dots or marks, respectively.
 .TP
+.BR "\-\-fixind"
+Fix broken quotes to adhere to RFC 3676 by removing spaces between quote
+characters and adding a space after them.
+.br
+.IR NOTE :
+This may produce false positives if spaces in between quote characters
+are intended (thus changing the quoting level, see RFC 3676 for details).
+.TP
 .B "\-\-groupwise"
 Hides TOFU as produced by Novell Groupwise.
 .TP
@@ -396,13 +408,8 @@ test to avoid false positives for Microsoft style TOFU on such messages.
 .TP
 .B "\-t"
 "TOFU deletion":
-Hides "traditional style" TOFU, where each line begins with an
-indent string like "> ".
-.br
-(You may edit the indent pattern in the script itself to suit your needs,
-but it is surely
-.I not
-recommended at all.)
+Hides "traditional style" TOFU, where each line begins with the
+indent string ">".
 .TP
 .B "\-w"
 "whitespace deletion":
@@ -424,7 +431,7 @@ If we really find some TOFU, abort with exit code
 Otherwise redirect the message to ADDRESS if given.
 .sp
 Intended for use from within mail delivery agents (MDAs) or mail transport 
-agents (MTAs), or even from with INN, so the message bounces if TOFU is
+agents (MTAs), or even from within INN, so the message bounces if TOFU is
 detected, and does not get on *your* nerves. :) 
 .sp
 As an example for usage with
@@ -690,7 +697,7 @@ and the part about "display_filter",
 .BR perl (1),
 .BR aliases (5),
 .sp
-RFCs 2045-2049 and 5322,
+RFCs 2045-2049, 3676 and 5322,
 .sp
 .I http://freshmeat.net/articles/t\-prot/
 (a nice, solid introduction),