X-Git-Url: https://git.deb.at/w?a=blobdiff_plain;f=t-prot.1;h=3d320756b8ea55972707961beb3d60a73e9bca21;hb=f9a85f8f92aa6166e63e9effe6b0681310e59ff8;hp=6ee7930727251d10e14bac30e7e86d181154351e;hpb=c76d75ee035107bbb03e21561b4c206e4efe7743;p=pkg%2Ft-prot.git diff --git a/t-prot.1 b/t-prot.1 index 6ee7930..3d32075 100644 --- a/t-prot.1 +++ b/t-prot.1 @@ -1,6 +1,6 @@ -.\" $Id: t-prot.1,v 1.178 2010/03/06 01:31:33 jochen Exp $ +.\" $Id: t-prot.1,v 1.187 2012/07/26 14:23:11 jochen Exp $ .\" -.TH T-PROT "1" "March 2010" "T-PROT" +.TH T-PROT "1" "July 2012" "T-PROT" .SH NAME t-prot \- TOFU Protection - Display Filter for RFC 5322 messages .SH SYNOPSIS @@ -25,15 +25,17 @@ 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 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. There is a -proof\-of\-concept filter for INN2, which you will have to adapt to -the needs of the news site you host (please see the file for details). +T\-prot offers example configuration files for mutt, Heirloom mailx +and metamail. Also coming with the t-prot package is the example +S-Lang macro t\-prot.sl for using t-prot from within slrn. There is +a proof\-of\-concept filter for INN2, which you will have to adapt +to the needs of the news site you host. For use with sendmail's +alias(5) file, please see below (the option +.BR "\-p" " provides an example line)." .SH OPTIONS .PP If you do not specify any options, t\-prot does ... nothing. Every -feature you want must be turned on explicitely. +feature you want must be turned on explicitly. Admittedly, we have quite a number of options for t\-prot. To limit confusion they are grouped into five sections: Input/Output Options, Advertisement And Mailing List Footers, Filtering Options, Detection @@ -50,10 +52,10 @@ then have a peek at the Detection Options section. You may accept or reject/bounce messages depending on t\-prot's result. .SH INPUT/OUTPUT OPTIONS .TP -.BR "\-i" " FILE" +.BR "\-i" "=FILE" Defines an input file; default is '\-' i.e. STDIN. .TP -.BR "\-o" " FILE" +.BR "\-o" "=FILE" Defines the output file; default is STDOUT. .TP .B "\-\-body" @@ -71,7 +73,9 @@ and should NEVER be used as a default, otherwise it will probably turn into a security issue.) .sp You can use this option safely to enable -.BR "\-o" " /dev/null." +.B "\-o" +/dev/null (or other files which cannot be changed with the user's +privileges). .TP .BR "\-\-max\-lines" =x Maximum number of lines a message may count (with headers). If the message @@ -114,9 +118,9 @@ little *too* greedy. .sp .IR NOTE : This requires a directory with footer files to be given with option -.BR "\-A" " DIRECTORY". +.BR "\-A" "=DIRECTORY". .TP -.BR "\-A" " DIRECTORY" +.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 @@ -139,7 +143,7 @@ option. .sp .IR NOTE : This requires a directory with footer files to be given with option -.BR "\-L" " DIRECTORY". +.BR "\-L" "=DIRECTORY". .B \-l is not needed if .B \-\-ftr\-ml @@ -155,9 +159,9 @@ 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". +.BR "\-L" "=DIRECTORY". .TP -.BR "\-L" " DIRECTORY" +.BR "\-L" "=DIRECTORY" "list footer directory": Defines the directory which contains the mailing list footers (one footer per file) which are to be tested when removing them with the options @@ -178,7 +182,7 @@ or Blocks of quotes with more than n lines will be shrunk to x lines. Defaults are 30 for n and 10 for x. .TP -.BR "\-c" " [n]" +.BR "\-c" "[=n]" "compress": Squeezes a sequence of blank lines to just n blank lines. n defaults to 2. .TP @@ -199,6 +203,14 @@ prey for Squeezes a sequence of four or more dots, exclamation marks, or question marks to only three dots or marks, respectively. .TP +.BR "\-\-fixind" +Fix broken quotes to adhere to RFC 3676 by removing spaces between quote +characters and adding a space after them. +.br +.IR NOTE : +This may produce false positives if spaces in between quote characters +are intended (thus changing the quoting level, see RFC 3676 for details). +.TP .B "\-\-groupwise" Hides TOFU as produced by Novell Groupwise. .TP @@ -320,14 +332,14 @@ Requires .BR "\-m" . .TP .B \-\-pgp\-move -Move PGP verification output to bottom; requires +Move PGP and SSL verification output to bottom; requires .BR "\-Mmutt" . .TP .B \-\-pgp\-move\-vrf -Move PGP verification output 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 -more likely to notice. Requires +Move PGP and SSL verification output 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 more likely to notice. Requires .BR "\-Mmutt" . .sp .IR NOTE : @@ -348,7 +360,7 @@ Hides all mail header lines. Subject lines with multiple reply prefixes (Re: and translations into other languages) get squeezed to only one prefix. .TP -.BR "\-S" " [n]" +.BR "\-S" "[=n]" "supression of overlong signatures": Signatures are to be n lines (not including the one containing dash-dash-space) or less. If there are more, it is probably not that spirited after all. @@ -396,13 +408,8 @@ test to avoid false positives for Microsoft style TOFU on such messages. .TP .B "\-t" "TOFU deletion": -Hides "traditional style" TOFU, where each line begins with an -indent string like "> ". -.br -(You may edit the indent pattern in the script itself to suit your needs, -but it is surely -.I not -recommended at all.) +Hides "traditional style" TOFU, where each line begins with the +indent string ">". .TP .B "\-w" "whitespace deletion": @@ -411,20 +418,20 @@ CAVEAT: This may lead to interesting effects with crossposts between mailing lists or with undetected signature attempts. .SH DETECTION OPTIONS .TP -.BR "\-P" " MESSAGE" +.BR "\-P" "=MESSAGE" "user defined bounce message for picky delivery": 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. See .BR "\-p" . .TP -.BR "\-p" " [ADDRESS]" +.BR "\-p" "[=ADDRESS]" "picky delivery": If we really find some TOFU, abort with exit code .IR EX_UNAVAILABLE . Otherwise redirect the message to ADDRESS if given. .sp Intended for use from within mail delivery agents (MDAs) or mail transport -agents (MTAs), or even from with INN, so the message bounces if TOFU is +agents (MTAs), or even from within INN, so the message bounces if TOFU is detected, and does not get on *your* nerves. :) .sp As an example for usage with @@ -592,7 +599,7 @@ Written by Jochen Striepe . All of the documentation and software included in the t-prot releases is copyrighted by Jochen Striepe (except when explicitly stated otherwise). .PP -Copyright \(co 2001-2010 Jochen Striepe. All rights reserved. +Copyright \(co 2001-2012 Jochen Striepe. All rights reserved. .PP Redistribution and use, with or without modification, are permitted provided that the following conditions are met: @@ -690,7 +697,7 @@ and the part about "display_filter", .BR perl (1), .BR aliases (5), .sp -RFCs 2045-2049 and 5322, +RFCs 2045-2049, 3676 and 5322, .sp .I http://freshmeat.net/articles/t\-prot/ (a nice, solid introduction),