finalize

[pkg/t-prot.git] / t-prot.1

diff --git a/t-prot.1 b/t-prot.1
index 7a328f8b260273ec137710f846f97f49ba704f91..1474fccfbdd5b4afdcbf7042fc762c7614d4477a 100644 (file)
--- a/t-prot.1
+++ b/t-prot.1
@@ -1,6 +1,6 @@
-.\" $Id: t-prot.1,v 1.182 2010/04/09 06:45:35 jochen Exp $
+.\" $Id: t-prot.1,v 1.192 2015/03/26 08:59:50 jochen Exp $

 .\"
 .\"

-.TH T-PROT "1" "April 2010" "T-PROT"
+.TH T-PROT "1" "March 2015" "T-PROT"

 .SH NAME
 t-prot \- TOFU Protection - Display Filter for RFC 5322 messages
 .SH SYNOPSIS
 .SH NAME
 t-prot \- TOFU Protection - Display Filter for RFC 5322 messages
 .SH SYNOPSIS


@@ -25,10 +25,10 @@ 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
 is the reason for not using standard CPAN modules for handling
 messages).
 .PP

-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
+T\-prot offers example configuration files for mutt and its fork mutt\-kz,
+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)."
 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)."


@@ -80,7 +80,8 @@ privileges).
 .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
 .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.
+unmodified. Exit status will be EX_DATAERR except when called with \-Mmutt
+or \-Mmutt\-kz.

 .SH ADVERTISEMENT AND MAILING LIST FOOTERS
 .TP
 .B "\-a"
 .SH ADVERTISEMENT AND MAILING LIST FOOTERS
 .TP
 .B "\-a"


@@ -182,7 +183,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
 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
 "compress":
 Squeezes a sequence of blank lines to just n blank lines. n defaults to 2.
 .TP


@@ -203,6 +204,14 @@ prey for
 Squeezes a sequence of four or more dots, exclamation marks, or question marks
 to only three dots or marks, respectively.
 .TP
 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
 .B "\-\-groupwise"
 Hides TOFU as produced by Novell Groupwise.
 .TP


@@ -253,14 +262,16 @@ Requires
 Specify which locale to use for correct parsing of your MUA's formatting
 of the displayed message (usually it is the locale your MUA uses). Right
 now this option is only used when
 Specify which locale to use for correct parsing of your MUA's formatting
 of the displayed message (usually it is the locale your MUA uses). Right
 now this option is only used when

-.I "\-Mmutt"
+.IR "\-Mmutt" " or"
+.I "\-Mmutt\-kz"

 is specified, but this may change in future. You need the Perl module
 .I "Locale::gettext"
 for this feature.
 .sp
 .IR NOTE :
 If you use
 is specified, but this may change in future. You need the Perl module
 .I "Locale::gettext"
 for this feature.
 .sp
 .IR NOTE :
 If you use

-.B mutt
+.BR mutt ,
+.B mutt-kz

 or
 .B gnupg
 with locales, t-prot will only work correctly if you specify the corresponding
 or
 .B gnupg
 with locales, t-prot will only work correctly if you specify the corresponding


@@ -276,24 +287,23 @@ You also have to make sure you are running t-prot
 with matching
 .B gnupg
 and 
 with matching
 .B gnupg
 and 

-.B mutt
+.BR mutt " /"
+.B "mutt\-kz"

 versions. T-prot detects
 .B gnupg
 and
 versions. T-prot detects
 .B gnupg
 and

-.B mutt
+.BR mutt " /"
+.B "mutt\-kz"

 locales of the recent stable versions of those programs, earlier versions
 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 some other
-.B mutt
-and
-.B gnupg
-versions.
+might not work well with a recent version of t-prot.

 .TP
 .TP

-.BR "\-M, \-\-mua" =MUA
+.BR "\-M, \-\-mua" MUA

 "mail user agent":
 Turn on special treatment for some mail user agents. (Right now only 
 .BR mutt (1)
 "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.)
+and
+.BR "mutt\-kz" (1)
+are 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.
 .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.


@@ -320,19 +330,22 @@ this option will probably just be interesting for mutt message hooks
 .BR know " the sender tries to write legible messages)."
 .sp
 Requires
 .BR know " the sender tries to write legible messages)."
 .sp
 Requires

-.BR "\-Mmutt" " and"
+.BR "\-Mmutt" " /"
+.BR "\-Mmutt\-kz" " and"

 .BR "\-m" .
 .TP
 .B \-\-pgp\-move
 .BR "\-m" .
 .TP
 .B \-\-pgp\-move

-Move PGP verification output to bottom; requires
-.BR "\-Mmutt" .
+Move PGP and SSL verification output to bottom; requires
+.BR "\-Mmutt" " /"
+.BR "\-Mmutt\-kz" .

 .TP
 .B \-\-pgp\-move\-vrf
 .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
-.BR "\-Mmutt" .
+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" " /"
+.BR "\-Mmutt\-kz" .

 .sp
 .IR NOTE :
 If gpg is terminated before finished (e.g. hitting Ctrl-C, or using
 .sp
 .IR NOTE :
 If gpg is terminated before finished (e.g. hitting Ctrl-C, or using


@@ -342,7 +355,8 @@ to be smart, there will be false positives.
 .TP
 .B \-\-pgp\-short
 Hide non-relevant PGP key uids; requires
 .TP
 .B \-\-pgp\-short
 Hide non-relevant PGP key uids; requires

-.BR "\-Mmutt" .
+.BR "\-Mmutt" " /"
+.BR "\-Mmutt\-kz" .

 .TP
 .B "\-r"
 "rip header off":
 .TP
 .B "\-r"
 "rip header off":


@@ -352,8 +366,8 @@ Hides all mail header lines.
 Subject lines with multiple reply prefixes (Re: and translations into other
 languages) get squeezed to only one prefix.
 .TP
 Subject lines with multiple reply prefixes (Re: and translations into other
 languages) get squeezed to only one prefix.
 .TP

-.BR "\-S" " [n]"
-"supression of overlong signatures":
+.BR "\-S" "[n]"
+"suppression 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.
 So with this option you trade it for a
 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.
 So with this option you trade it for a


@@ -400,13 +414,8 @@ test to avoid false positives for Microsoft style TOFU on such messages.
 .TP
 .B "\-t"
 "TOFU deletion":
 .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":
 .TP
 .B "\-w"
 "whitespace deletion":


@@ -479,7 +488,7 @@ The environment variables
 .IR LC_MESSAGES ,
 and
 .I LANG
 .IR LC_MESSAGES ,
 and
 .I LANG

-are read and respected when interpreting output by mutt or gnupg
+are read and respected when interpreting output by mutt / mutt\-kz or gnupg

 (unless they are overruled by the \-\-locale option). T-prot's own
 output is English regardless of any locale setting.
 .SH EXIT STATUS
 (unless they are overruled by the \-\-locale option). T-prot's own
 output is English regardless of any locale setting.
 .SH EXIT STATUS


@@ -532,9 +541,10 @@ files as absolutely needed in any footer directory.
 All PGP related options are eating up lots of CPU time. Try to avoid them
 on unsigned and unencrypted messages.
 .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.
+When calling t-prot from within mutt (or mutt\-kz), 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 :
 .SH TROUBLESHOOTING
 .TP
 .IR Q :


@@ -554,7 +564,7 @@ your line is empty you match unconditionally.
 .PP
 .TP
 .IR Q :
 .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 suppress mailing list footers when

 displaying messages in
 .BR mutt (1).
 This does work sometimes, but sometimes it does not: the footer is not
 displaying messages in
 .BR mutt (1).
 This does work sometimes, but sometimes it does not: the footer is not


@@ -596,7 +606,7 @@ Written by Jochen Striepe <t\-prot@tolot.escape.de>.
 All of the documentation and software included in the t-prot releases
 is copyrighted by Jochen Striepe (except when explicitly stated otherwise).
 .PP
 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-2015 Jochen Striepe. All rights reserved.                     

 .PP
 Redistribution and use, with or without modification, are permitted
 provided that the following conditions are met:
 .PP
 Redistribution and use, with or without modification, are permitted
 provided that the following conditions are met:


@@ -689,12 +699,13 @@ section). Beside that, all main features should be implemented by now.
 See the TODO file for more information.
 .SH "SEE ALSO"
 .BR mutt (1),
 See the TODO file for more information.
 .SH "SEE ALSO"
 .BR mutt (1),

+.BR mutt\-kz (1),

 .BR muttrc (5)
 and the part about "display_filter", 
 .BR perl (1),
 .BR aliases (5),
 .sp
 .BR muttrc (5)
 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),
 .sp
 .I http://freshmeat.net/articles/t\-prot/
 (a nice, solid introduction),