Imported Upstream version 3.0

[pkg/t-prot.git] / README

diff --git a/README b/README
index 3636629e3ba51f6a67242882213bc2f563aa99b4..4fa5264be5d75f7b8ea2461b9465c9f31549f087 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
-   t-prot -- TOFU protection
-   =========================
+T-PROT -- TOFU protection
+=========================

 
 1. What the hell is TOFU?
    As the man page says:
 
 1. What the hell is TOFU?
    As the man page says:


@@ -10,45 +10,37 @@
    text  at  the  top;  obviously  they  think that quoted text must not be
    changed at all.  This is quite annoying as it needlessly sends a lot  of
    data  even when it is not required. Some editing of messages is desired.
    text  at  the  top;  obviously  they  think that quoted text must not be
    changed at all.  This is quite annoying as it needlessly sends a lot  of
    data  even when it is not required. Some editing of messages is desired.

-   Please point these people to the  page  http://learn.to/edit_messages  -
-   thank you!
+   Please point these people to the page
+     http://www.river.com/users/share/etiquette/edit.html
+   Thank you!

 
 2. What does the script do?
 
 2. What does the script do?

-   It detects, and when demanded hides annoying parts in rfc822 messages:
-   TOFU,  signatures  (especially  when  they  are  too long),  excessive
-   punktuation, blocks of empty lines, trailing spaces and tabs.
-   For use inside of MTAs or MDAs it may exit with appropriate libc exit
-   codes, so annoying messages may be bounced easily.
+   It detects,  and when demanded  hides annoying parts in rfc5322 messages:
+   TOFU, huge quoted blocks, signatures (especially when they are too long),
+   excessive punctuation,  blocks of empty lines,  trailing spaces and tabs.
+   For use inside of MTAs or MDAs it exits with appropriate libc exit codes,
+   so annoying messages may be bounced easily.

    
 3. For what can I use it?
    There are  several possibilities.  One is  to filter your email  or news 
    
 3. For what can I use it?
    There are  several possibilities.  One is  to filter your email  or news 

-   messages when displaying them in your MUA.  Another is blocking annoying
-   messages entirely from your system  -  using the script in some sendmail
-   or procmail rule, or perhaps even inside innd.
+   messages when  displaying them  in your User Agent.  Another is blocking
+   annoying messages entirely from your system  -  using the script in some
+   sendmail  (see the man page for an  example)  or procmail rule,  or even
+   inside innd.

 
 4. Give me some example!  What about  an example configuration  for the MUA 
 
 4. Give me some example!  What about  an example configuration  for the MUA 

-   mutt(1)?
+   mutt(1), or the NUA slrn(1)?

    An example is included in the distribution.  Please see the man page for
    further details on the activated features.
 
    An example is included in the distribution.  Please see the man page for
    further details on the activated features.
 

-5. And what about other MUAs?
-   I just use mutt, so I do not know how to filter messages in other MUAs.
-   If you know how to incorporate t-prot e.g. in Gnus, please just drop me
-   a note. ;)
+5. And what about other User Agents?
+   I just use mutt and slrn, but I will gladly accept configuration samples
+   for other user agents. There are already examples for mailcap(1) and the
+   Heirloom mailx (a.k.a. nail) in the contrib/ directory.

 
 

-6. And what about an example for bouncing emails?
-   Put a line like the following in your /etc/mail/aliases:
-   ------SNIPP------
-   notofu: |"/usr/local/bin/t-prot -cemtS -p=user@mydomain"
-   ------SNIPP------
-   (Do not forget to call `newaliases`.)  Messages for notofu@mydomain will
-   be scanned for TOFU.  If t-prot found TOFU in a message, it will bounce,
-   otherwise it will be  forwarded to user@mydomain.  This works great with
-   sendmail,  if you use another MTA you probably have to adapt it.
-
-7. Where did the idea come from?
-   Many thanks to Gerhard H. Wrodnigg who uses a TOFU protection script 
-   in order to keep the responses to his cancel bot reasonably short.  The
+6. Where did the idea come from?
+   Many thanks  to  Gerhard H. Wrodnigg  who uses a  TOFU protection script 
+   in order to keep  the responses to his cancel bot reasonably short.  The

    entire inspiration for this hack came from the "TOFU protection" line of
    his script on many usenet postings.
 
    entire inspiration for this hack came from the "TOFU protection" line of
    his script on many usenet postings.