-.\" $Id: t-prot.1,v 1.129 2007/03/09 15:05:35 jochen Exp $
+.\" $Id: t-prot.1,v 1.143 2010/01/05 11:46:38 jochen Exp $
.\"
-.TH T-PROT "1" "December 2006" "T-PROT"
+.TH T-PROT "1" "January 2010" "T-PROT"
.SH NAME
t-prot \- TOFU Protection - Display Filter for RFC 2822 messages
.SH SYNOPSIS
-.BI "t-prot [" OPTIONS "]..."
+.BI "t\-prot [" OPTIONS "]..."
.SH DESCRIPTION
.PP
This program is a filter to improve the readability of
is the reason for not using standard CPAN modules for handling
messages).
.PP
-For easy usage, you can download a file to be included in your ~/.muttrc:
-.I http://www.escape.de/users/tolot/mutt/t-prot/muttrc.t-prot
-.br
-And here is an example S-Lang macro to use t-prot from within slrn:
-.I http://www.escape.de/users/tolot/mutt/t-prot/t-prot.sl
+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.
.SH OPTIONS
.TP
.BR "\-A" =DIRECTORY
"ad footer directory":
Defines the directory which contains the advertisement list footers (one
footer per file) which are to be tested when removing them with options
-.B -a
+.B \-a
or
-.BR --ftr-ad .
+.BR \-\-ftr\-ad .
.br
This option is also needed if you do not want signature lengths to be
counted wrong or fullquotes get undetected when an ad footer is
(which is mandatory for this option). The comparison is done by perl's
.B index()
function (please try
-.I perldoc -f index
+.I perldoc \-f index
for details).
.sp
.IR NOTE :
This option is not needed if
-.B --ftr-ad
+.B \-\-ftr\-ad
is specified.
.TP
.BR "\-\-bigq" [=n[,x]]
lines.
.IP
.IR NOTE :
-This does not work with --pgp-short, and multipart messages will not
+This does not work with \-\-pgp\-short, and multipart messages will not
be detected due to missing headers.
.TP
.B "\-c"
.IR ratio [=n]
.br
If the quoting ratio is n or more, the message is rejected. Must be
-between 0 and 1, or else it is entirely disabled.
+between 0 and 1, or else it is entirely disabled. Default is 0.75
+(i.e., three quarters are quoted).
.TP
.B "\-d, \-\-debug"
"debug":
be helpful with broken list servers, or even if your email provider munges
the bodies of your messages.
.br
-Works similar to --ftr-ad, just that it is intended for mailing list footers.
+Works similar to \-\-ftr\-ad, just that it is intended for mailing list footers.
.sp
.IR NOTE :
This requires a directory with footer files to be given with option
.BR "\-L" =DIRECTORY.
.TP
+.B "\-\-groupwise"
+"delete Groupwise style TOFU":
+Hides TOFU as produced by Novell Groupwise.
+.TP
.B "\-h, \-\-help"
"help":
Displays a short help text with a summary on all options, and exits.
.TP
.BR "\-i" =FILE
"input file":
-Defines a file for input; the default input is from '-' i.e. STDIN.
+Defines a file for input; the default input is from '\-' i.e. STDIN.
.TP
.B "\-k"
"anti Kammquote":
Hides TOFU as given by some Microsoft mailers. (You all surely know these
fullquotes beginning with
.br
-"----- Original Message -----"
+"\-\-\-\-\- Original Message \-\-\-\-\-"
.br
and some header lines...)
.TP
.BR "\-m" .
.TP
.BR "\-\-max\-lines" =x
-Maximum number of lines a message body may count. If the body is longer
-than x lines, the message will not be processed but printed unmodified.
+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.
.TP
.BR "\-o" =FILE
"output file":
put this line into your alias file and invoke
.BR newaliases :
.sp
-notofu: |"/usr/local/bin/t-prot -mt -p=user@mydomain"
+notofu: |"/usr/local/bin/t\-prot \-mt \-p=user@mydomain"
.sp
This will bounce messages for <notofu@domainname> if any TOFU is detected
inside the message, and deliver it to <user@mydomain> otherwise.
conformance.)
.sp
.IR NOTE :
-The line containing "-- " ist not counted when testing for an overlong
+The line containing "\-\- " ist not counted when testing for an overlong
signature, but it is included when displaying how many lines were deleted.
.TP
.B "\-s"
and
.I LANG
are read and respected when interpreting output by mutt or gnupg
-(unless they are overruled by the --locale option). T-prot's own
+(unless they are overruled by the \-\-locale option). T-prot's own
output is English regardless of any locale setting.
.SH EXIT STATUS
On program exit, t-prot uses exit codes from
There are several ways to fine-tune t-prot's performance:
.PP
Some command line options are quite grave a performance hit -- do not
-use -k and especially --ms-smart if you are content without them.
+use \-k and especially \-\-ms\-smart if you are content without them.
.PP
Checking for special footers is very costly as well. Put as few footer
files as absolutely needed in any footer directory.
.PP
.TP
.IR Q :
-I use the options -l and -L to supress mailing list footers when
+I use the options \-l and \-L to supress mailing list footers when
displaying messages in
.BR mutt (1).
This does work sometimes, but sometimes it does not: the footer is not
This might occur if the message is badly encoded, so mutt cannot resolve
all encoded characters, e.g. if you have an encoded message on a mailing
list, and majordomo appends a mailing list footer in a different encoding
-(or even plain us-ascii). "-- " simply does not match "--=20".
+(or even plain us-ascii). "\-\- " simply does not match "\-\-=20".
.br
Another problem are non-us-ascii characters. Just avoid them, and
everything should work fine.
.sp
#v+
.br
-This line is protected from being filtered by t-prot !!!!!!!
+This line is protected from being filtered by t\-prot !!!!!!!
.br
-#v-
+#v\-
.br
Text coming now is not.
.SH AUTHOR
-Written by Jochen Striepe <t-prot@tolot.escape.de>.
+Written by Jochen Striepe <t\-prot@tolot.escape.de>.
.SH COPYRIGHT
All of the documentation and software included in the t-prot releases
-is copyrighted by Jochen Striepe (except when explicitely stated otherwise).
+is copyrighted by Jochen Striepe (except when explicitly stated otherwise).
.PP
-Copyright \(co 2001-2006 Jochen Striepe. All rights reserved.
+Copyright \(co 2001-2010 Jochen Striepe. All rights reserved.
.PP
Redistribution and use, with or without modification, are permitted
provided that the following conditions are met:
There is a problem when mutt gives a PGP verified or even a multipart
message to t-prot: The information where the PGP encrypted/signed data
or even attachments begin and end is plainly embedded in the text, not
-really cleanly recognizeable for t-prot. The problem should be worked
+really cleanly recognizable for t-prot. The problem should be worked
around by now, please send a bug report if it does not work for you.
.SH "REPORTING BUGS"
Please note that t-prot development happens on
.I display_filter
facility, just set display_filter to something like
.IP
-"tee ~/foobar | t-prot <your options>"
+"tee ~/foobar | t\-prot <your options>"
.PP
and include ~/foobar in the bug report -- this way we might reproduce
the bug much easier if you are using a different environment than we do.
be important to enable us reproducing the bug.
.PP
Send your bug report to
-.IR <t-prot-bugs@tolot.escape.de> .
+.IR <t\-prot\-bugs@tolot.escape.de> .
Thank you.
.SH TODO
Fix bugs (see the
projects / pkg / t-prot.git / blobdiff