X-Git-Url: https://git.deb.at/w?p=pkg%2Ft-prot.git;a=blobdiff_plain;f=t-prot.1;h=035f9b975cad773157ef0891848a9d5fb0bd6e73;hp=6848fa8352bcb6a7160865d5be76c1641f15d3b1;hb=60da21df18142fa6f9aa3be2a09593f0acd1cd1d;hpb=5a2416caa59ac3c35002955d0159450b47320ed9 diff --git a/t-prot.1 b/t-prot.1 index 6848fa8..035f9b9 100644 --- a/t-prot.1 +++ b/t-prot.1 @@ -1,40 +1,38 @@ -.\" $Id: t-prot.1,v 1.117 2005/06/29 12:45:55 jochen Exp $ +.\" $Id: t-prot.1,v 1.148 2010/02/07 14:31:14 jochen Exp $ .\" -.TH T-PROT "1" "June 2005" "T-PROT" +.TH T-PROT "1" "February 2010" "T-PROT" .SH NAME -t-prot \- TOFU Protection - Display Filter for RFC 2822 messages +t-prot \- TOFU Protection - Display Filter for RFC 5322 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 The filter is written in Perl and relies on input to be a single -message conforming to RFC 822 or its successor, RFC 2822. Messages -conforming to RFCs 2045-2049 should be treated reasonably correct. +message conforming to RFC 822 or its successors, RFC 2822 and RFC 5322. +Messages conforming to RFCs 2045-2049 should be treated reasonably correct. .PP Already reformatted messages are handled well: the script was initially designed to cope with the output of the MUA mutt (which is the reason for not using standard CPAN modules for handling 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 -.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 +For easy usage, you can include the file muttrc.t\-prot in your +~/.muttrc. Also coming with the t-prot package is the example S-Lang +macro t\-prot.sl for using t-prot from within slrn. .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 @@ -53,17 +51,17 @@ footer file found in the directory specified with (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" @@ -71,12 +69,12 @@ Input consists just of the message's body. There are no RFC 2822 header 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" "compress": -Squeezes a sequence of blank lines to two blank lines at maximum. +Squeezes a sequence of blank lines to just two blank lines. .TP .BR "\-\-check" [=FLAGS] Run checks. If successful, print an error message and quit with @@ -89,10 +87,10 @@ following (right now just one flag): .IR ratio [=n] .br If the quoting ratio is n or more, the message is rejected. Must be -between 0 and 1, or else it is entirely disabled. +between 0 and 1, or else it is entirely disabled. Default is 0.75 +(i.e., 75% of the message lines are quotes). .TP .B "\-d, \-\-debug" -"debug": Print envelope info to syslog when bouncing TOFU contaminated email. Default syslog facility is mail.debug. Requires .BR \-p . @@ -114,7 +112,7 @@ to only three dots or marks, respectively. .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 @@ -137,19 +135,21 @@ With this option enabled t-prot makes footer detection really greedy: Should 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" +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": @@ -159,7 +159,8 @@ wrapped around by some MUAs which are known as "Kammquoting" in German. .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 @@ -262,18 +263,27 @@ and .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 @@ -291,14 +301,10 @@ Requires .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. Exit status will be EX_DATAERR except when called with -Mmutt. .TP .BR "\-o" =FILE "output file": @@ -323,7 +329,7 @@ As an example for usage with 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 if any TOFU is detected inside the message, and deliver it to otherwise. @@ -341,13 +347,13 @@ You may specify your own bounce message to be returned when we try to deliver 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 @@ -358,7 +364,7 @@ we cannot always detect if the check was interrupted. Though t-prot tries 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" @@ -378,7 +384,7 @@ than 4. Consider this old-fashioned, but we actually do *like* RFC 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" @@ -421,8 +427,7 @@ CAVEAT: This may lead to interesting effects with crossposts between mailing lists or with undetected signature attempts. .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 , @@ -430,7 +435,7 @@ The environment variables 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 @@ -470,6 +475,21 @@ even when it is not required. Some editing of messages is desired. 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 : @@ -489,7 +509,7 @@ your line is empty you match unconditionally. .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 @@ -500,7 +520,7 @@ detected as too long (which they aren't). 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. @@ -520,18 +540,18 @@ instruction: .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 . +Written by Jochen Striepe . .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-2010 Jochen Striepe. All rights reserved. .PP Redistribution and use, with or without modification, are permitted provided that the following conditions are met: @@ -561,8 +581,8 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .SH IDEAS AND INSPIRATION Many good ideas, bug reports and support from (in alphabetical order) Bjoern Buerger, Bjoern Laessig, Christian Borss, Gerfried Fuchs, Martin Neitzel, Martin -Dietze, Ralf Doeblitz, Sven Guckes and many more (see the ChangeLog for active -contributors). Many thanks to all of them! +Dietze, Matthias Kilian, Ralf Doeblitz, Sven Guckes and many more (see the +ChangeLog for active contributors). Many thanks to all of them! .sp 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 @@ -572,20 +592,20 @@ his script on many usenet postings. 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 recognizable 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 @@ -605,7 +625,7 @@ t-prot team with some useful info, please: .I display_filter facility, just set display_filter to something like .IP -"tee ~/foobar | t-prot " +"tee ~/foobar | t\-prot " .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. @@ -615,7 +635,7 @@ with, what perl version t-prot runs on your system, and what else might be important to enable us reproducing the bug. .PP Send your bug report to -.IR . +.IR . Thank you. .SH TODO Fix bugs (see the @@ -629,7 +649,7 @@ and the part about "display_filter", .BR perl (1), .BR aliases (5), .sp -RFCs 2045-2049 and 2822, +RFCs 2045-2049 and 5322, .sp .I http://got.to/quote/ (German language),