From da4000da5e0253b10d59fdc04baafdadd43ca4fd Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Sat, 10 Sep 2016 14:39:33 +0000
Subject:  Allow s6-ipcserver-socketbinder to create SOCK_DGRAM sockets and to
 not listen() (suggested by Daniel Kahn Gillmor)

---
 doc/s6-ipcserver-socketbinder.html | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

(limited to 'doc')

diff --git a/doc/s6-ipcserver-socketbinder.html b/doc/s6-ipcserver-socketbinder.html
index 8f9d990..9bfaec5 100644
--- a/doc/s6-ipcserver-socketbinder.html
+++ b/doc/s6-ipcserver-socketbinder.html
@@ -26,11 +26,11 @@ socket, then executes a program.
 <h2> Interface </h2>
 
 <pre>
-     s6-ipcserver-socketbinder [ -d | -D ] [ -b <em>backlog</em> ] <em>path</em> <em>prog...</em>
+     s6-ipcserver-socketbinder [ -d | -D ] [ -b <em>backlog</em> ] [ -M | -m ] <em>path</em> <em>prog...</em>
 </pre>
 
 <ul>
- <li> s6-ipcserver-socketbinder creates a Unix domain socket of type SOCK_STREAM
+ <li> s6-ipcserver-socketbinder creates a Unix domain socket
 and binds it to <em>path</em>. It prepares the socket to accept
 connections by calling
 <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/listen.html">listen()</a>. </li>
@@ -48,8 +48,17 @@ and is generally used with server programs. This is the default. Note that
 <em>path</em> will be deleted if it already exists at program start time. </li>
  <li> <tt>-D</tt>&nbsp;: disallow instant rebinding to the same path. </li>
  <li> <tt>-b&nbsp;<em>backlog</em></tt>&nbsp;: set a maximum of
-<em>backlog</em> backlog connections on the socket. Extra
-connection attempts will rejected by the kernel. </li>
+<em>backlog</em> backlog connections on the socket - extra
+connection attempts will rejected by the kernel. The default is SOMAXCONN,
+i.e. the maximum number allowed by the system. If <em>backlog</em>
+is 0, then the socket will be created, but it <strong>will not be
+listening</em>. </li>
+ <li> <tt>-M</tt>&nbsp;: the type of the socket will be SOCK_STREAM. This is
+the default. </li>
+ <li> <tt>-m</tt>&nbsp;: the type of the socket will be SOCK_DGRAM. Note
+that by default SOCK_DGRAM sockets are not connection-mode, and <tt>listen()</tt>
+will fail - so you should always give the <tt>-b0</tt> option to
+s6-ipcserver-socketbinder along with <tt>-m</tt>. </li>
 </ul>
 
 <h2> Notes </h2>
-- 
cgit v1.2.3