1 .\" $Id: t-prot.1,v 1.127 2006/09/25 14:42:18 jochen Exp $
3 .TH T-PROT "1" "July 2006" "T-PROT"
5 t-prot \- TOFU Protection - Display Filter for RFC 2822 messages
7 .BI "t-prot [" OPTIONS "]..."
10 This program is a filter to improve the readability of
11 messages (emails and usenet posts) by *hiding* some annoying parts,
12 e.g. mailing list footers, signatures, and TOFU (see definition below),
13 as well as squeezing sequences of blank lines or punctuation.
15 The filter is written in Perl and relies on input to be a single
16 message conforming to RFC 822 or its successor, RFC 2822. Messages
17 conforming to RFCs 2045-2049 should be treated reasonably correct.
19 Already reformatted messages are handled well: the script was
20 initially designed to cope with the output of the MUA mutt (which
21 is the reason for not using standard CPAN modules for handling
24 For easy usage, you can download a file to be included in your ~/.muttrc:
25 .I http://www.escape.de/users/tolot/mutt/t-prot/muttrc.t-prot
27 And here is an example S-Lang macro to use t-prot from within slrn:
28 .I http://www.escape.de/users/tolot/mutt/t-prot/t-prot.sl
32 "ad footer directory":
33 Defines the directory which contains the advertisement list footers (one
34 footer per file) which are to be tested when removing them with options
39 This option is also needed if you do not want signature lengths to be
40 counted wrong or fullquotes get undetected when an ad footer is
41 appended at the bottom of the message (especially when using
47 "commercial signature":
48 Hides "footers" (signatures) from commercial email providers.
50 This option compares the last lines of the message body with any
51 footer file found in the directory specified with
53 (which is mandatory for this option). The comparison is done by perl's
60 This option is not needed if
64 .BR "\-\-bigq" [=n[,x]]
66 Blocks of quotes with more than n lines will be shrunk to x lines.
67 Defaults are 30 for n and 10 for x.
70 Input consists just of the message's body. There are no RFC 2822 header
74 This does not work with --pgp-short, and multipart messages will not
75 be detected due to missing headers.
79 Squeezes a sequence of blank lines to two blank lines at maximum.
81 .BR "\-\-check" [=FLAGS]
82 Run checks. If successful, print an error message and quit with
83 an appropriate exit code. Useful e.g. for rejecting messages from
86 Flags are separated by commas (no whitespaces), and can be the
87 following (right now just one flag):
91 If the quoting ratio is n or more, the message is rejected. Must be
92 between 0 and 1, or else it is entirely disabled.
96 Print envelope info to syslog when bouncing TOFU contaminated email.
97 Default syslog facility is mail.debug. Requires
102 Tolerate unified diff (see
106 appended *after* the signature (which usually makes the signature too long
107 to be valid). Not entirely consequent but sometimes useful, e.g. at the
108 Linux kernel mailing list.
112 Squeezes a sequence of four or more dots, exclamation marks, or question marks
113 to only three dots or marks, respectively.
116 "enable aggressive ad footer matching":
117 With this option enabled, t-prot makes footer detection really greedy: We
118 assume that commercial email providers aren't even frightened to append
119 changing texts *under* their ads which are appended to the message body.
120 Because these texts even have changing lengths we simply detect the
121 lines of the footer *anywhere* in the body of the message and assume that
122 everything below belongs to the footer. (Man, if life where always that
125 With this option even GMX ads should be easy to hide -- you buy this with
126 a slight performance hit (which is the reason this option is disabled by
127 default), and with the possibility that sometimes the algorithm is just a
131 This requires a directory with footer files to be given with option
132 .BR "\-A" =DIRECTORY.
135 "enable aggressive mailing list footer matching":
136 With this option enabled t-prot makes footer detection really greedy: Should
137 be helpful with broken list servers, or even if your email provider munges
138 the bodies of your messages.
140 Works similar to --ftr-ad, just that it is intended for mailing list footers.
143 This requires a directory with footer files to be given with option
144 .BR "\-L" =DIRECTORY.
148 Displays a short help text with a summary on all options, and exits.
152 Defines a file for input; the default input is from '-' i.e. STDIN.
156 Tries (not too aggressively) to fix those broken zig-zag-shaped lines
157 wrapped around by some MUAs which are known as "Kammquoting" in German.
160 This option is considered stable by now. However, sometimes Kammquotes
161 should have been removed but weren't. Please send a bug report if this
162 happens to you (after carefully reading the BUGS and REPORTING BUGS
163 section of this man page, that is).
165 Please also note that enabling this option is quite a performance hit.
168 Minimum line length for wrapped line detection on Kammquotes. For
169 details, please see the source code.
171 Anyway, lower values make the algorithm more aggressive, higher values
172 make Kammquotes harder to detect. Default is 65.
178 Maximum line length for wrapped line detection on Kammquotes. For
179 details, please see the source code.
181 Anyway, higher values make the algorithm more aggressive, lower values
182 make Kammquotes harder to detect. Default is 80.
188 Minimum length difference between two lines for wrapped line detection on
189 Kammquotes. For details, please see the source code.
191 Anyway, lower values make the algorithm more aggressive, higher values
192 make Kammquotes harder to detect. Default is 20.
198 "list footer directory":
199 Defines the directory which contains the mailing list footers (one footer
200 per file) which are to be tested when removing them with the options
205 This option is also needed if you do not want signature lengths to be
206 counted wrong or fullquotes get undetected when a mailing list footer is
207 appended at the bottom of the message (especially when using
214 Hides "footers" (signatures) from mailing lists. Footer detection works like the
219 This requires a directory with footer files to be given with option
220 .BR "\-L" =DIRECTORY.
226 .B "\-\-lax\-security"
227 Allow insecure writing method. DO NOT USE UNLESS YOU REALLY KNOW WHAT
228 YOU ARE DOING. (This ugly workaround is needed for some early mutt versions
229 and should NEVER be used as a default, otherwise it will probably turn into
232 .BR "\-\-locale" =LOCALE
234 Here you can specify which locale to use. Right now this option is only
237 is specified, but this may change in future. You need the Perl module
246 with locales, t-prot will only work correctly if you specify the corresponding
247 locale string. Alternatively, you can use the environment variables
252 to specify the locale string.
255 You also have to make sure you are running t-prot
260 versions. T-prot detects
264 locales of the recent stable versions of those programs, earlier versions
265 might not work well with a recent version of t-prot. There are patches available
266 to make t-prot fit into environments with some other
274 Hides TOFU as given by some Microsoft mailers. (You all surely know these
275 fullquotes beginning with
277 "----- Original Message -----"
279 and some header lines...)
282 Burn CPU cycles trying to be smart with MS style TOFU.
284 Please note that this is probably just a waste of time because most
285 MS Outlook users who do produce this kind of TOFU won't care about
286 making their messages the least bit readable or even predictable. So
287 this option will probably just be interesting for mutt message hooks
288 (to activate it on demand when you
289 .BR know " the sender tries to write legible messages)."
295 .BR "\-M, \-\-mua" =MUA
297 Turn on special treatment for some mail user agents. (Right now only
299 is supported, but more might be added in future.)
301 If your MUA is supported by this feature you must ensure t-prot makes
302 use of it when called from within your MUA to work as desired.
306 Define the file to be written *to*; the default output is to STDOUT.
308 If "NONE" is specified as file name, there will be no output at all (useful
309 if all you need is t-prot's exit code). Use something like "./NONE" if you
310 really want to write to a file of this name.
314 If we really find some TOFU, abort with exit code
316 Otherwise redirect the message to ADDRESS if given.
318 Intended for use from within mail delivery agents (MDAs) or mail transport
319 agents (MTAs), or even from with INN, so the message bounces if TOFU is
320 detected, and does not get on *your* nerves. :)
322 As an example for usage with
324 put this line into your alias file and invoke
327 notofu: |"/usr/local/bin/t-prot -mt -p=user@mydomain"
329 This will bounce messages for <notofu@domainname> if any TOFU is detected
330 inside the message, and deliver it to <user@mydomain> otherwise.
332 that TOFU is only detected if you specify
337 .B PLEASE be careful not to bounce messages to mailing lists!
340 "user defined bounce message for picky delivery":
341 You may specify your own bounce message to be returned when we try to deliver
342 an email and bounce it because there is TOFU inside.
345 Move PGP verification output to bottom; requires
348 .B \-\-pgp\-move\-vrf
349 Move PGP verification outout to bottom only if verification shows a good signature
350 and the signature could be verified as authentic (using a trust path). If there is
351 any problem with the signature, the PGP output should not be moved so the user is
352 more likely to notice. Requires
356 If gpg is terminated before finished (e.g. hitting Ctrl-C, or using
358 we cannot always detect if the check was interrupted. Though t-prot tries
359 to be smart, there will be false positives.
362 Hide non-relevant PGP key uids; requires
367 Hides all mail header lines.
370 "supression of overlong signatures":
371 Signatures are to be n lines (not including the one containing dash-dash-space)
372 or less. If there are more, it is probably not that spirited after all.
373 So with this option you trade it for a
377 If no n is given, default is 4. (We do not recommend using a value other
378 than 4. Consider this old-fashioned, but we actually do *like* RFC
382 The line containing "-- " ist not counted when testing for an overlong
383 signature, but it is included when displaying how many lines were deleted.
386 "signature deletion":
387 Hides signatures, i.e. all lines after a "signature dashes" line,
388 i.e. a line with three characters: dash-dash-space (no more, no less).
390 .BR "\-\-sigsmax" [=n]
391 "maximum number of tolerated signatures":
392 Here you can define how many signatures you accept to be treated as such.
393 (Most significant behaviour is when microsoft style quotes are removed.
394 Experts please see the code for the more subtle implications of this
397 Leave empty or specify zero to have an unlimited number of sigs.
401 "SpamAssassin workaround":
402 SpamAssassin (available at
403 .IR http://spamassassin.org/ ") often is configured that it adds some"
404 lines to the message body containing information about the spam criteria
405 which were found matching for the message. This option enables an extra
406 test to avoid false positives for Microsoft style TOFU on such messages.
410 Hides "traditional style" TOFU, where each line begins with an
411 indent string like "> ".
413 (You may edit the indent pattern in the script itself to suit your needs,
419 "whitespace deletion":
420 Hides trailing whitespace (sequences of space and tab).
421 CAVEAT: This may lead to interesting effects with crossposts
422 between mailing lists or with undetected signature attempts.
424 .B "\-v, \-\-version"
426 Prints the current version number and release date, and exit.
428 The environment variables
433 are read and respected when interpreting output by mutt or gnupg
434 (unless they are overruled by the --locale option). T-prot's own
435 output is English regardless of any locale setting.
437 On program exit, t-prot uses exit codes from
438 .I /usr/include/sysexits.h
439 and thus behaves in a manner that sendmail and others understand when
442 Currently, the codes used are
460 If, however, perl fails to compile and execute t-prot, perl's normal
461 exit codes will be returned.
463 TOFU is an abbreviation which mixes German and English words;
464 it expands to "text oben, full-quote unten" which means
465 "text above - full quote below" and describes the style of so
466 many users who let their mailer or newsreader quote everything
467 of the previous message and just add some text at the top;
468 obviously they think that quoted text must not be changed at all.
469 This is quite annoying as it needlessly sends a lot of data
470 even when it is not required. Some editing of messages is desired.
471 Please point these people to the page
472 .I http://www.river.com/users/share/etiquette/edit.html
475 There are several ways to fine-tune t-prot's performance:
477 Some command line options are quite grave a performance hit -- do not
478 use -k and especially --ms-smart if you are content without them.
480 Checking for special footers is very costly as well. Put as few footer
481 files as absolutely needed in any footer directory.
483 All PGP related options are eating up lots of CPU time. Try to avoid them
484 on unsigned and unencrypted messages.
486 When calling t-prot from within mutt, you might use mutt's folder-hook
487 and message-hook facilities to turn options on only when needed, e.g. to
488 set up a different footer directory for each mailing list folder.
492 I want to make my mailing list footer files match more different mailing
493 list footers. Can I use regular expressions, or how can I accomplish
497 Nope, regexp's do not work here. The comparison is made by the perl
502 for more detailed info), so you must exactly match the beginning of the
503 line. The longer the line you specify, the more precise the match; if
504 your line is empty you match unconditionally.
508 I use the options -l and -L to supress mailing list footers when
509 displaying messages in
511 This does work sometimes, but sometimes it does not: the footer is not
512 detected, and therefore full quotes are not deleted and signatures are
513 detected as too long (which they aren't).
516 This might occur if the message is badly encoded, so mutt cannot resolve
517 all encoded characters, e.g. if you have an encoded message on a mailing
518 list, and majordomo appends a mailing list footer in a different encoding
519 (or even plain us-ascii). "-- " simply does not match "--=20".
521 Another problem are non-us-ascii characters. Just avoid them, and
522 everything should work fine.
524 See the preceding Q+A for a solution.
528 I want to write a message which contains parts that should *not* be
529 deleted even when filtered with t-prot. Is this possible?
532 Yes, but please do not spread word of it. Make unobstrusive use of the
539 This line is protected from being filtered by t-prot !!!!!!!
543 Text coming now is not.
545 Written by Jochen Striepe <t-prot@tolot.escape.de>.
547 All of the documentation and software included in the t-prot releases
548 is copyrighted by Jochen Striepe (except when explicitely stated otherwise).
550 Copyright \(co 2001-2006 Jochen Striepe. All rights reserved.
552 Redistribution and use, with or without modification, are permitted
553 provided that the following conditions are met:
555 1. Redistributions of source code must retain the above copyright notice,
556 this list of conditions and the following disclaimer.
558 2. All advertising materials mentioning features or use of this software
559 must display the following acknowledgement:
561 This product includes software developed by Jochen Striepe and others.
563 3. Neither the name of the author nor the names of any contributors may
564 be used to endorse or promote products derived from this software without
565 specific prior written permission.
567 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY
568 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
569 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
570 DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY
571 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
572 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
573 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
574 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
575 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
576 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
577 .SH IDEAS AND INSPIRATION
578 Many good ideas, bug reports and support from (in alphabetical order) Bjoern
579 Buerger, Bjoern Laessig, Christian Borss, Gerfried Fuchs, Martin Neitzel, Martin
580 Dietze, Ralf Doeblitz, Sven Guckes and many more (see the ChangeLog for active
581 contributors). Many thanks to all of them!
583 Many thanks to Gerhard H. Wrodnigg who uses a TOFU protection script
584 in order to keep the responses to his cancel bot reasonably short. The
585 entire inspiration for this hack came from the "TOFU protection" line of
586 his script on many usenet postings.
588 You can get the latest version from
589 .IR http://www.escape.de/users/tolot/mutt/ .
591 There is a problem when mutt gives a PGP verified or even a multipart
592 message to t-prot: The information where the PGP encrypted/signed data
593 or even attachments begin and end is plainly embedded in the text, not
594 really cleanly recognizeable for t-prot. The problem should be worked
595 around by now, please send a bug report if it does not work for you.
597 Please note that t-prot development happens on
598 .BR "current stable perl versions only" .
599 If you do run t-prot on earlier (or unstable) perl versions, you might
600 encounter perl compiler bugs (or funny t-prot behaviour). One solution
601 is to upgrade your perl, another is simply to write a bug report. If
602 you do not run a current perl version, please include this information
609 * you found it in the TODO file coming with the distribution. We do
610 know those and try to fix them as soon as possible.
612 * you have an old t-prot version. If you encounter a problem, first
613 see if there is a new t-prot version which fixes the issue. If you
614 upgraded to the latest version and it still occurs, a bug report is
617 If you noticed a bug when processing a message and want to provide the
618 t-prot team with some useful info, please:
620 * if invoking t-prot by mutt's
622 facility, just set display_filter to something like
624 "tee ~/foobar | t-prot <your options>"
626 and include ~/foobar in the bug report -- this way we might reproduce
627 the bug much easier if you are using a different environment than we do.
629 * provide information on what command line options you use t-prot
630 with, what perl version t-prot runs on your system, and what else might
631 be important to enable us reproducing the bug.
633 Send your bug report to
634 .IR <t-prot-bugs@tolot.escape.de> .
639 section). Beside that, all main features should be implemented by now.
640 See the TODO file for more information.
644 and the part about "display_filter",
648 RFCs 2045-2049 and 2822,
650 .I http://got.to/quote/
653 .I http://www.river.com/users/share/etiquette/edit.html
654 (the Learn To Edit Messages HowTo has found a new home).