X-Git-Url: https://git.deb.at/w?a=blobdiff_plain;f=t-prot.1;h=c732e3d6cd67c7e5dec804ff2479e20b4ae79733;hb=ea1861c197b63523f945dbfc8c41ba3c53a8e49c;hp=6848fa8352bcb6a7160865d5be76c1641f15d3b1;hpb=5a2416caa59ac3c35002955d0159450b47320ed9;p=pkg%2Ft-prot.git diff --git a/t-prot.1 b/t-prot.1 index 6848fa8..c732e3d 100644 --- a/t-prot.1 +++ b/t-prot.1 @@ -1,14 +1,14 @@ -.\" $Id: t-prot.1,v 1.117 2005/06/29 12:45:55 jochen Exp $ +.\" $Id: t-prot.1,v 1.132 2007/09/19 11:32:59 jochen Exp $ .\" -.TH T-PROT "1" "June 2005" "T-PROT" +.TH T-PROT "1" "September 2007" "T-PROT" .SH NAME t-prot \- TOFU Protection - Display Filter for RFC 2822 messages .SH SYNOPSIS .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 @@ -63,7 +63,7 @@ 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" @@ -114,7 +114,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 @@ -143,6 +143,10 @@ Works similar to --ftr-ad, just that it is intended for mailing list footers. This requires a directory with footer files to be given with option .BR "\-L" =DIRECTORY. .TP +.B "\-\-groupwise" +"delete Groupwise style TOFU": +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. @@ -159,7 +163,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,12 +267,21 @@ 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 @@ -291,14 +305,9 @@ 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 body may count. If the body is longer +than x lines, the message will not be processed but printed unmodified. .TP .BR "\-o" =FILE "output file": @@ -341,13 +350,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 +367,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" @@ -422,7 +431,7 @@ 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 , @@ -470,6 +479,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 : @@ -529,9 +553,9 @@ Text coming now is not. 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 explicitely stated otherwise). .PP -Copyright \(co 2001-2005 Jochen Striepe. All rights reserved. +Copyright \(co 2001-2007 Jochen Striepe. All rights reserved. .PP Redistribution and use, with or without modification, are permitted provided that the following conditions are met: @@ -572,20 +596,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 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 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