X-Git-Url: https://git.deb.at/w?p=pkg%2Ft-prot.git;a=blobdiff_plain;f=t-prot.1;h=6f776d53fdec2ae9a3209bb587e5945aadfb7851;hp=35b1d34c4416bcccd8a8864642f9d77052784e1f;hb=refs%2Fheads%2Fetch-backports;hpb=2d178478460edcfdc4055642761b157ecb32c28f diff --git a/t-prot.1 b/t-prot.1 index 35b1d34..6f776d5 100644 --- a/t-prot.1 +++ b/t-prot.1 @@ -1,14 +1,14 @@ -.\" $Id: t-prot.1,v 1.121 2006/06/17 12:34:54 jochen Exp $ +.\" $Id: t-prot.1,v 1.129 2007/03/09 15:05:35 jochen Exp $ .\" -.TH T-PROT "1" "June 2006" "T-PROT" +.TH T-PROT "1" "December 2006" "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 @@ -263,12 +263,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 @@ -292,14 +301,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": @@ -342,13 +346,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 @@ -359,7 +363,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" @@ -423,7 +427,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 , @@ -471,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 : @@ -530,7 +549,7 @@ 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-2006 Jochen Striepe. All rights reserved. .PP