X-Git-Url: https://git.deb.at/?a=blobdiff_plain;f=README;h=90527c8e0b8079ef4ebf12908974280c49e4dcc0;hb=16728fd5c22256ccbfd2566942df5c07eb18a194;hp=3636629e3ba51f6a67242882213bc2f563aa99b4;hpb=9a69a9aaad35184ed236f415208041bf19e747e3;p=pkg%2Ft-prot.git diff --git a/README b/README index 3636629..90527c8 100644 --- 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: @@ -10,45 +10,62 @@ 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? - 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 punktuation, 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 - 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 - 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. -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. ;) - -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 +5. And what about other User Agents? + I just use mutt and slrn, so I do not know how to filter messages in + other User Agents. If you know how to incorporate t-prot e.g. in Gnus, + please just drop me a note. ;) + +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. + +T-PROT AND SUPPORT FOR GETOPT::LONG +=================================== + +Most distributions (it seems to me) are quite eager to abandon Getopt::Mixed, +having Getopt::Long in the official Perl package, which does everything the +former module did. Getopt::Mixed is unmaintained and marked deprecated by +its author, so why keep it? + +The answer is simple: because it's much faster (GNU time(1) tells me 28% +faster for running my complete t-prot release test suite consisting of +real-life emails) than anything I could get out of Getopt::Long. Plus, +from my point of view, there are no problems having a package installed +that is well-tested and just works fine (you don't need updates and more +new shiny features if the software just does what you want it to do). + +So we have the choice between easy maintainance and better performance. + +For the time being, I made my choice and keep sticking to Getopt::Mixed as +long as it works as-is with current stable perl versions. That does not mean +I don't see the merits of a well-maintained standard module, which is already +available on any perl system out there. Thus, a patch is provided to allow +easy migration to Getopt::Long for anyone who likes this better. I hope +this solution is fine for everyone. +