From eb9672690c8cd08572556b689951639d04ff7c63 Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Fri, 4 Jun 2021 19:42:33 +0000
Subject:  Change to run as a child, not a parent

---
 doc/smtpd-starttls-proxy-io.html | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

(limited to 'doc/smtpd-starttls-proxy-io.html')

diff --git a/doc/smtpd-starttls-proxy-io.html b/doc/smtpd-starttls-proxy-io.html
index 9f699b9..2bf20ca 100644
--- a/doc/smtpd-starttls-proxy-io.html
+++ b/doc/smtpd-starttls-proxy-io.html
@@ -18,13 +18,28 @@
 
 <h1> The <tt>smtpd-starttls-proxy-io</tt> program </h1>
 
+<p>
+<tt>smtpd-starttls-proxy-io</tt> is a program that runs in front of a UCSPI-compliant
+SMTP server (such as <tt>qmail-smtpd</tt>) and extends it with STARTTLS
+capability.
+</p>
+
+<p>
+ <tt>smtpd-starttls-proxy-io</tt> provides no TLS on its own;
+instead, it expects to be run under a
+<a href="https://web.archive.org/web/20150311223933/http://www.suspectclass.com/sgifford/ucspi-tls/ucspi-tls.txt">UCSPI-TLS</a>
+server, and interfaces with it.
+</p>
+
 <h2> Interface </h2>
 
 <pre>
-     smtpd-starttls-proxy-io <em>server...</em>
+     smtpd-starttls-proxy-io <em>smtpd...</em>
 </pre>
 
 <ul>
+ <li> <tt>smtpd-starttls-proxy-io</tt> spawns <em>smtpd...</em> as
+a child process. It interposes itself between 
 </ul>
 
 </body>
-- 
cgit v1.3.1