X-Git-Url: https://git.deb.at/w?a=blobdiff_plain;f=t-prot.1;h=a19136bc20dcf579ec34671aa8b352b728a710e4;hb=16728fd5c22256ccbfd2566942df5c07eb18a194;hp=035f9b975cad773157ef0891848a9d5fb0bd6e73;hpb=eaaeebe9048266deff624831bf50ba847ae7f048;p=pkg%2Ft-prot.git

diff --git a/t-prot.1 b/t-prot.1
index 035f9b9..a19136b 100644
--- a/t-prot.1
+++ b/t-prot.1
@@ -1,4 +1,4 @@
-.\" $Id: t-prot.1,v 1.148 2010/02/07 14:31:14 jochen Exp $
+.\" $Id: t-prot.1,v 1.157 2010/02/15 20:08:19 jochen Exp $
 .\"
 .TH T-PROT "1" "February 2010" "T-PROT"
 .SH NAME
@@ -7,10 +7,13 @@ t-prot \- TOFU Protection - Display Filter for RFC 5322 messages
 .BI "t\-prot [" OPTIONS "]..."
 .SH DESCRIPTION
 .PP
-This program is a filter to improve the readability of
+This program is a filter to improve the readability of internet
 messages (emails and usenet posts) by *hiding* some annoying parts,
 e.g. mailing list footers, signatures, and TOFU (see definition below),
 as well as squeezing sequences of blank lines or punctuation.
+The program also detects TOFU or a high quoting ratio in a message (so
+you may take appropriate action, e.g. when submitting messages to a mailing
+list or a news server).
 .br
 The filter is written in Perl and relies on input to be a single
 message conforming to RFC 822 or its successors, RFC 2822 and RFC 5322.
@@ -23,7 +26,9 @@ 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.
+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).
 .SH OPTIONS
 .TP
 .BR "\-A" =DIRECTORY
@@ -65,7 +70,7 @@ Blocks of quotes with more than n lines will be shrunk to x lines.
 Defaults are 30 for n and 10 for x.
 .TP
 .B "\-\-body"
-Input consists just of the message's body. There are no RFC 2822 header
+Input consists just of the message's body. There are no RFC 5322 header
 lines.
 .IP
 .IR NOTE :
@@ -164,12 +169,12 @@ section of this man page, that is).
 .IP
 Please also note that enabling this option is quite a performance hit.
 .TP
-.BR "\-\-kminl" =n
-Minimum line length for wrapped line detection on Kammquotes. For
-details, please see the source code.
+.BR "\-\-kdiff" =n
+Minimum length difference between two lines for wrapped line detection on
+Kammquotes. For details, please see the source code.
 .br
 Anyway, lower values make the algorithm more aggressive, higher values
-make Kammquotes harder to detect. Default is 65.
+make Kammquotes harder to detect. Default is 20.
 .sp
 Requires
 .BR "\-k" .
@@ -184,12 +189,12 @@ make Kammquotes harder to detect. Default is 80.
 Requires
 .BR "\-k" .
 .TP
-.BR "\-\-kdiff" =n
-Minimum length difference between two lines for wrapped line detection on
-Kammquotes. For details, please see the source code.
+.BR "\-\-kminl" =n
+Minimum line length for wrapped line detection on Kammquotes. For
+details, please see the source code.
 .br
 Anyway, lower values make the algorithm more aggressive, higher values
-make Kammquotes harder to detect. Default is 20.
+make Kammquotes harder to detect. Default is 65.
 .sp
 Requires
 .BR "\-k" .
@@ -287,6 +292,11 @@ fullquotes beginning with
 .br
 and some header lines...)
 .TP
+.BR "\-\-max\-lines" =x
+Maximum number of lines a message may count (with headers). If the message
+is longer than x lines, the message will not be processed but printed
+unmodified. Exit status will be EX_DATAERR except when called with \-Mmutt.
+.TP
 .B "\-\-ms\-smart"
 Burn CPU cycles trying to be smart with MS style TOFU.
 .sp
@@ -301,11 +311,6 @@ Requires
 .BR "\-Mmutt" " and"
 .BR "\-m" .
 .TP
-.BR "\-\-max\-lines" =x
-Maximum number of lines a message may count (with headers). If the message
-is longer than x lines, the message will not be processed but printed
-unmodified. Exit status will be EX_DATAERR except when called with -Mmutt.
-.TP
 .BR "\-o" =FILE
 "output file":
 Define the file to be written *to*; the default output is to STDOUT.
@@ -314,6 +319,12 @@ If "NONE" is specified as file name, there will be no output at all (useful
 if all you need is t-prot's exit code). Use something like "./NONE" if you
 really want to write to a file of this name.
 .TP
+.BR "\-P" =MESSAGE
+"user defined bounce message for picky delivery": 
+You may specify your own bounce message to be returned when we try to deliver
+an email and bounce it because there is TOFU inside. See
+.BR "\-p" .
+.TP
 .BR "\-p" [=ADDRESS]
 "picky delivery":
 If we really find some TOFU, abort with exit code 
@@ -341,11 +352,6 @@ respectively
 .sp
 .B PLEASE be careful not to bounce messages to mailing lists!
 .TP
-.BR "\-P" =MESSAGE
-"user defined bounce message for picky delivery": 
-You may specify your own bounce message to be returned when we try to deliver
-an email and bounce it because there is TOFU inside.
-.TP
 .B \-\-pgp\-move
 Move PGP verification output to bottom; requires
 .BR "\-Mmutt" .
@@ -371,6 +377,10 @@ Hide non-relevant PGP key uids; requires
 "rip header off":
 Hides all mail header lines.
 .TP
+.B "\-\-reply"
+Subject lines with multiple reply prefixes (Re: and translations into other
+languages) get squeezed to only one prefix.
+.TP
 .BR "\-S" [=n]
 "supression of overlong signatures":
 Signatures are to be n lines (not including the one containing dash-dash-space)
@@ -392,6 +402,13 @@ signature, but it is included when displaying how many lines were deleted.
 Hides signatures, i.e. all lines after a "signature dashes" line,
 i.e. a line with three characters: dash-dash-space (no more, no less).
 .TP
+.B "\-\-sani"
+Sanitize headers "To:", "From:" and "Subject:": Quoted-printable gets
+fixed to the corresponding chars. German Umlauts are translated to their
+"ae", "oe", "ue" pendants.
+.br
+Useful e.g. for searching by subject within MUAs like Berkeley mailx.
+.TP
 .BR "\-\-sigsmax" [=n]
 "maximum number of tolerated signatures":
 Here you can define how many signatures you accept to be treated as such.
@@ -651,6 +668,9 @@ and the part about "display_filter",
 .sp
 RFCs 2045-2049 and 5322,
 .sp
+.I http://freshmeat.net/articles/t\-prot/
+(a nice, solid introduction),
+.br
 .I http://got.to/quote/
 (German language),
 .br