From cb33213374aee70e755df8f0b9a6434d4a11b6a2 Mon Sep 17 00:00:00 2001
From: Leah Neukirchen <leah@vuxu.org>
Date: Sun, 7 Jan 2018 23:00:06 +0100
Subject: mshow.1: explain filter exit statuses

---
 man/mshow.1 | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'man')

diff --git a/man/mshow.1 b/man/mshow.1
index dbb0d9d..b33b889 100644
--- a/man/mshow.1
+++ b/man/mshow.1
@@ -125,6 +125,25 @@ The environment variable
 .Ev PIPE_CHARSET
 will be set to the charset declared in the MIME part,
 if known.
+.Pp
+Filters can communicate with
+.Nm
+using their exit status:
+.Bl -tag -compact -width 8n
+.It 0
+The output is printed as plain text.
+.It 62
+The output is printed raw, without escaping.
+.It 63
+Behave as if the filter never ran.
+.It 64
+The output is a RFC5322 message that should be rendered again.
+.It 65 to 80
+Render the
+.Va n Ns \&- Ns 64th
+part of this text/multipart part.
+.El
+All other exit statuses are regarded as errors.
 .Sh ENVIRONMENT
 .Bl -tag -width MBLAZE_NOCOLOR
 .It Ev MBLAZE_PAGER
-- 
cgit 1.4.1