Merge branch 'upstream'

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

diff --git a/t-prot.1 b/t-prot.1
index 00ee120188c8b17e8a928807604a8a1fa728cf62..35b1d34c4416bcccd8a8864642f9d77052784e1f 100644 (file)
--- a/t-prot.1
+++ b/t-prot.1
@@ -1,6 +1,6 @@
-.\" $Id: t-prot.1,v 1.115 2005/05/13 00:06:10 jochen Exp $
+.\" $Id: t-prot.1,v 1.121 2006/06/17 12:34:54 jochen Exp $
 .\"
-.TH T-PROT "1" "May 2005" "T-PROT"
+.TH T-PROT "1" "June 2006" "T-PROT"
 .SH NAME
 t-prot \- TOFU Protection - Display Filter for RFC 2822 messages
 .SH SYNOPSIS
@@ -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
@@ -432,6 +433,32 @@ and
 are read and respected when interpreting output by mutt 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
+On program exit, t-prot uses exit codes from
+.I /usr/include/sysexits.h
+and thus behaves in a manner that sendmail and others understand when
+calling t-prot.
+.sp
+Currently, the codes used are
+.RS 20
+.PD 0
+.TP
+EX_OK
+.TP
+EX_USAGE
+.TP
+EX_DATAERR
+.TP
+EX_UNAVAILABLE
+.TP
+EX_SOFTWARE
+.TP
+EX_IOERR
+.PD
+.RE
+.sp
+If, however, perl fails to compile and execute t-prot, perl's normal
+exit codes will be returned.
 .SH TOFU?
 TOFU is an abbreviation which mixes German and English words;
 it expands to "text oben, full-quote unten" which means
@@ -505,7 +532,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.
 .PP
-Copyright \(co 2001-2005 Jochen Striepe. All rights reserved.                     
+Copyright \(co 2001-2006 Jochen Striepe. All rights reserved.                     
 .PP
 Redistribution and use, with or without modification, are permitted
 provided that the following conditions are met:
@@ -546,20 +573,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
@@ -602,9 +629,12 @@ See the TODO file for more information.
 and the part about "display_filter", 
 .BR perl (1),
 .BR aliases (5),
+.sp
 RFCs 2045-2049 and 2822,
+.sp
 .I http://got.to/quote/
-(German language), 
+(German language),
+.br
 .I http://www.river.com/users/share/etiquette/edit.html
 (the Learn To Edit Messages HowTo has found a new home).