-.\" $Id: t-prot.1,v 1.117 2005/06/29 12:45:55 jochen Exp $
+.\" $Id: t-prot.1,v 1.136 2009/12/20 21:38:41 jochen Exp $
.\"
-.TH T-PROT "1" "June 2005" "T-PROT"
+.TH T-PROT "1" "August 2009" "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 which shall improve the readability for
-messages (emails and usenet postings) by *hiding* some annoying parts,
+This program is a filter to improve the readability of
+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.
.br
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
+.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
+.I http://www.escape.de/users/tolot/mutt/t\-prot/t\-prot.sl
.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]]
"shrink big quotes":
-Blocks of quotes with more than n lines will be shrinked to x lines.
+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"
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"
.TP
.B "\-\-ftr\-ad"
"enable aggressive ad footer matching":
-With this option enabled t-prot makes footer detection really greedy: We
+With this option enabled, t-prot makes footer detection really greedy: We
assume that commercial email providers aren't even frightened to append
changing texts *under* their ads which are appended to the message body.
Because these texts even have changing lengths we simply detect the
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":
.IR NOTE :
This option is considered stable by now. However, sometimes Kammquotes
should have been removed but weren't. Please send a bug report if this
-happens to you (after carefully reading the BUGS file, that is).
+happens to you (after carefully reading the BUGS and REPORTING BUGS
+section of this man page, that is).
.IP
Please also note that enabling this option is quite a performance hit.
.TP
.B mutt
locales of the recent stable versions of those programs, earlier versions
might not work well with a recent version of t-prot. There are patches available
-to make t-prot fit into environments with old
+to make t-prot fit into environments with some other
.B mutt
and
.B gnupg
versions.
.TP
+.BR "\-M, \-\-mua" =MUA
+"mail user agent":
+Turn on special treatment for some mail user agents. (Right now only
+.BR mutt (1)
+is supported, but more might be added in future.)
+.IR Caveat :
+If your MUA is supported by this feature you must ensure t-prot makes
+use of it when called from within your MUA to work as desired.
+.TP
.B "\-m"
"Microsoft TOFU":
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 "\-Mmutt" " and"
.BR "\-m" .
.TP
-.BR "\-M, \-\-mua" =MUA
-"mail user agent":
-Turn on special treatment for some mail user agents. (Right now only
-.BR mutt (1)
-is supported, but more might be added in future.)
-.IR Caveat :
-If your MUA is supported by this feature you must ensure t-prot makes
-use of it when called from within your MUA to work as desired.
+.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.
.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.
an email and bounce it because there is TOFU inside.
.TP
.B \-\-pgp\-move
-Move pgp verification output to bottom; requires
+Move PGP verification output to bottom; requires
.BR "\-Mmutt" .
.TP
.B \-\-pgp\-move\-vrf
-Move pgp verification outout to bottom only if verification shows a good signature
+Move PGP verification outout to bottom only if verification shows a good signature
and the signature could be verified as authentic (using a trust path). If there is
-any problem with the signature, the pgp output should not be moved so the user is
+any problem with the signature, the PGP output should not be moved so the user is
more likely to notice. Requires
.BR "\-Mmutt" .
.sp
to be smart, there will be false positives.
.TP
.B \-\-pgp\-short
-Hide non-relevant pgp key uids; requires
+Hide non-relevant PGP key uids; requires
.BR "\-Mmutt" .
.TP
.B "\-r"
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"
.TP
.B "\-v, \-\-version"
"version info":
-Prints the current version number and release date, and exit.
+Prints the current version number and release date, and exits.
.SH ENVIRONMENT
The environment variables
.IR LC_ALL ,
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
Please point these people to the page
.I http://www.river.com/users/share/etiquette/edit.html
- thank you!
+.SH PERFORMANCE
+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.
+.PP
+Checking for special footers is very costly as well. Put as few footer
+files as absolutely needed in any footer directory.
+.PP
+All PGP related options are eating up lots of CPU time. Try to avoid them
+on unsigned and unencrypted messages.
+.PP
+When calling t-prot from within mutt, you might use mutt's folder-hook
+and message-hook facilities to turn options on only when needed, e.g. to
+set up a different footer directory for each mailing list folder.
.SH TROUBLESHOOTING
.TP
.IR Q :
.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.
+is copyrighted by Jochen Striepe (except when explicitly stated otherwise).
.PP
-Copyright \(co 2001-2005 Jochen Striepe. All rights reserved.
+Copyright \(co 2001-2009 Jochen Striepe. All rights reserved.
.PP
Redistribution and use, with or without modification, are permitted
provided that the following conditions are met:
You can get the latest version from
.IR http://www.escape.de/users/tolot/mutt/ .
.SH BUGS
+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
+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
.BR "current stable perl versions only" .
If you do run t-prot on earlier (or unstable) perl versions, you might
encounter perl compiler bugs (or funny t-prot behaviour). One solution
is to upgrade your perl, another is simply to write a bug report. If
you do not run a current perl version, please include this information
-in your bug report. Thank you.
+in your bug report.
.PP
-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
-around by now, please send a bug report if it does not work for you.
-.SH "REPORTING BUGS"
Please do
.I not
report a bug if
.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