docs: fix pop3d/pop3proxyd man pages

These have been quietly broken for a while, but a recent change made them noisily broken so I finally noticed...
cyrusimap · Apr 26, 2024 · 4ec1b07 · 4ec1b07
1 parent 7078a71
commit 4ec1b07
Show file tree

Hide file tree

Showing 3 changed files with 99 additions and 98 deletions.
diff --git a/docsrc/assets/man-pop3d.rst b/docsrc/assets/man-pop3d.rst
@@ -0,0 +1,96 @@
+Synopsis
+========
+
+.. parsed-literal::
+
+    **pop3d** [ **-C** *config-file* ] [ **-U** *uses* ] [ **-T** *timeout* ] [ **-D** ]
+        [ **-H** ] [ **-s** ] [ **-k** ] [ **-p** *ssf* ]
+
+Description
+===========
+
+**pop3d** is an POP3 server.  It accepts commands on its standard
+input and responds on its standard output.  It MUST be invoked by
+:cyrusman:`master(8)` with those descriptors attached to a remote client
+connection.
+
+**pop3d** |default-conf-text|
+
+If the directory ``log``\/*user* exists under the directory specified in
+the ``configdirectory`` configuration option, then **pop3d** will create
+protocol telemetry logs for sessions authenticating as *user*.
+
+The telemetry logs will be stored in the ``log``/\ *user* directory with
+a filename of the **pop3d** process-id.
+
+Options
+=======
+
+.. program:: pop3d
+
+.. option:: -C config-file
+
+    |cli-dash-c-text|
+
+.. option:: -U  uses
+
+    The maximum number of times that the process should be used for new
+    connections before shutting down.  The default is 250.
+
+.. option:: -T  timeout
+
+    The number of seconds that the process will wait for a new
+    connection before shutting down.  Note that a value of 0 (zero)
+    will disable the timeout.  The default is 60.
+
+.. option:: -D
+
+    Run external debugger specified in debug_command.
+
+.. option:: -H
+
+    Tell **httpd** to expect a HAProxy protocol header from the sender.
+
+.. option:: -s
+
+    Serve POP3 over SSL (pop3s).  All data to and from **pop3d** is
+    encrypted using the Secure Sockets Layer.
+
+.. option:: -k
+
+    Serve MIT's KPOP (Kerberized POP) protocol instead.
+
+.. option:: -p  ssf
+
+    Tell **pop3d** that an external layer exists.  An *SSF* (security
+    strength factor) of 1 means an integrity protection layer exists.
+    Any higher SSF implies some form of privacy protection.
+
+Examples
+========
+
+**pop3d** is commonly included in the SERVICES section of
+:cyrusman:`cyrus.conf(5)` like so:
+
+.. parsed-literal::
+    SERVICES {
+        imap        cmd="imapd -U 30" listen="imap" prefork=0
+        imaps       cmd="imapd -s -U 30" listen="imaps" prefork=0 maxchild=100
+        **pop3        cmd="pop3d -U 30" listen="pop3" prefork=0**
+        **pop3s       cmd="pop3d -s -U 30" listen="pop3s" prefork=0 maxchild=100**
+        lmtpunix    cmd="lmtpd" listen="/var/run/cyrus/socket/lmtp" prefork=0 maxchild=20
+        sieve       cmd="timsieved" listen="sieve" prefork=0
+        notify      cmd="notifyd" listen="/var/run/cyrus/socket/notify" proto="udp" prefork=1
+        httpd       cmd="httpd" listen=8080 prefork=1 maxchild=20
+    }
+
+Files
+=====
+
+/etc/imapd.conf
+
+See Also
+========
+
+:cyrusman:`imapd.conf(5)`,
+:cyrusman:`master(8)`
diff --git a/docsrc/imap/reference/manpages/systemcommands/pop3d.rst b/docsrc/imap/reference/manpages/systemcommands/pop3d.rst
@@ -10,99 +10,4 @@
 
 POP3 server process
 
-Synopsis
-========
-
-.. parsed-literal::
-
-    **pop3d** [ **-C** *config-file* ] [ **-U** *uses* ] [ **-T** *timeout* ] [ **-D** ]
-        [ **-H** ] [ **-s** ] [ **-k** ] [ **-p** *ssf* ]
-
-Description
-===========
-
-**pop3d** is an POP3 server.  It accepts commands on its standard
-input and responds on its standard output.  It MUST be invoked by
-:cyrusman:`master(8)` with those descriptors attached to a remote client
-connection.
-
-**pop3d** |default-conf-text|
-
-If the directory ``log``\/*user* exists under the directory specified in
-the ``configdirectory`` configuration option, then **pop3d** will create
-protocol telemetry logs for sessions authenticating as *user*.
-
-The telemetry logs will be stored in the ``log``/\ *user* directory with
-a filename of the **pop3d** process-id.
-
-Options
-=======
-
-.. program:: pop3d
-
-.. option:: -C config-file
-
-    |cli-dash-c-text|
-
-.. option:: -U  uses
-
-    The maximum number of times that the process should be used for new
-    connections before shutting down.  The default is 250.
-
-.. option:: -T  timeout
-
-    The number of seconds that the process will wait for a new
-    connection before shutting down.  Note that a value of 0 (zero)
-    will disable the timeout.  The default is 60.
-
-.. option:: -D
-
-    Run external debugger specified in debug_command.
-
-.. option:: -H
-
-    Tell **httpd** to expect a HAProxy protocol header from the sender.
-
-.. option:: -s
-
-    Serve POP3 over SSL (pop3s).  All data to and from **pop3d** is
-    encrypted using the Secure Sockets Layer.
-
-.. option:: -k
-
-    Serve MIT's KPOP (Kerberized POP) protocol instead.
-
-.. option:: -p  ssf
-
-    Tell **pop3d** that an external layer exists.  An *SSF* (security
-    strength factor) of 1 means an integrity protection layer exists.
-    Any higher SSF implies some form of privacy protection.
-
-Examples
-========
-
-**pop3d** is commonly included in the SERVICES section of
-:cyrusman:`cyrus.conf(5)` like so:
-
-.. parsed-literal::
-    SERVICES {
-        imap        cmd="imapd -U 30" listen="imap" prefork=0
-        imaps       cmd="imapd -s -U 30" listen="imaps" prefork=0 maxchild=100
-        **pop3        cmd="pop3d -U 30" listen="pop3" prefork=0**
-        **pop3s       cmd="pop3d -s -U 30" listen="pop3s" prefork=0 maxchild=100**
-        lmtpunix    cmd="lmtpd" listen="/var/run/cyrus/socket/lmtp" prefork=0 maxchild=20
-        sieve       cmd="timsieved" listen="sieve" prefork=0
-        notify      cmd="notifyd" listen="/var/run/cyrus/socket/notify" proto="udp" prefork=1
-        httpd       cmd="httpd" listen=8080 prefork=1 maxchild=20
-    }
-
-Files
-=====
-
-/etc/imapd.conf
-
-See Also
-========
-
-:cyrusman:`imapd.conf(5)`,
-:cyrusman:`master(8)`
+.. include:: /assets/man-pop3d.rst
diff --git a/docsrc/imap/reference/manpages/systemcommands/pop3proxyd.rst b/docsrc/imap/reference/manpages/systemcommands/pop3proxyd.rst
@@ -6,7 +6,7 @@
 **pop3proxyd**
 ==============
 
-
-This is a hard linked copy of :cyrusman:`pop3d(8)`, retained for backwards compatibility from when a murder frontend used its own pop3d binaries.
+This is a hard linked copy of :cyrusman:`pop3d(8)`, retained for backwards
+compatibility from when a murder frontend used its own pop3d binaries.
 
 .. include:: /assets/man-pop3d.rst