finalize
[pkg/t-prot.git] / README
1 T-PROT -- TOFU protection
2 =========================
3
4 1. What the hell is TOFU?
5    As the man page says:
6    TOFU is an abbreviation which mixes German and English words; it expands
7    to "text oben, full-quote unten" which means "text above  -  full  quote
8    below"  and describes the style of so many users who let their mailer or
9    newsreader quote everything of the previous message and  just  add  some
10    text  at  the  top;  obviously  they  think that quoted text must not be
11    changed at all.  This is quite annoying as it needlessly sends a lot  of
12    data  even when it is not required. Some editing of messages is desired.
13    Please point these people to the page
14      http://www.river.com/users/share/etiquette/edit.html
15    Thank you!
16
17 2. What does the script do?
18    It detects,  and when demanded  hides annoying parts in rfc5322 messages:
19    TOFU, huge quoted blocks, signatures (especially when they are too long),
20    excessive punctuation,  blocks of empty lines,  trailing spaces and tabs.
21    For use inside of MTAs or MDAs it exits with appropriate libc exit codes,
22    so annoying messages may be bounced easily.
23    
24 3. For what can I use it?
25    There are  several possibilities.  One is  to filter your email  or news 
26    messages when  displaying them  in your User Agent.  Another is blocking
27    annoying messages entirely from your system  -  using the script in some
28    sendmail  (see the man page for an  example)  or procmail rule,  or even
29    inside innd.
30
31 4. Give me some example!  What about  an example configuration  for the MUA 
32    mutt(1), or the NUA slrn(1)?
33    An example is included in the distribution.  Please see the man page for
34    further details on the activated features.
35
36 5. And what about other User Agents?
37    I just use mutt and slrn, but I will gladly accept configuration samples
38    for other user agents. There are already examples for mailcap(1) and the
39    Heirloom mailx (a.k.a. nail) in the contrib/ directory. The mutt example
40    works with mutt-kz as well.
41
42 6. Where did the idea come from?
43    Many thanks  to  Gerhard H. Wrodnigg  who uses a  TOFU protection script 
44    in order to keep  the responses to his cancel bot reasonably short.  The
45    entire inspiration for this hack came from the "TOFU protection" line of
46    his script on many usenet postings.
47