From 2d0e823aa9f574fa0291f716c8a7e45bafe464d3 Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Wed, 3 Jul 2019 15:50:50 +0000
Subject:  Update doc to reflect the removal of s6-fdholder-*c programs

---
 doc/s6-fdholder-setdump.html | 30 +++++++++++++++++++-----------
 1 file changed, 19 insertions(+), 11 deletions(-)

(limited to 'doc/s6-fdholder-setdump.html')

diff --git a/doc/s6-fdholder-setdump.html b/doc/s6-fdholder-setdump.html
index 2baafd0..f5c30e9 100644
--- a/doc/s6-fdholder-setdump.html
+++ b/doc/s6-fdholder-setdump.html
@@ -32,15 +32,11 @@ that daemon.
 </pre>
 
 <ul>
- <li> s6-fdholder-setdump executes into <tt><a href="s6-ipcclient.html">s6-ipcclient</a> <em>path</em>
-<a href="s6-fdholder-setdumpc.html">s6-fdholder-setdumpc</a> <em>id</em></tt>. It does nothing else: it is just a
-convenience program. The <a href="s6-ipcclient.html">s6-ipcclient</a> program connects
-to a Unix socket at <em>path</em>, and the
-<a href="s6-fdholder-setdumpc.html">s6-fdholder-setdumpc</a> program transmits the
-file descriptors over the socket. </li>
- <li> It should be used to connect to a
-<a href="s6-fdholderd.html">s6-fdholderd</a> daemon, which will store the set of
-file descriptors. </li>
+ <li> <tt>s6-fdholder-setdump</tt> connects to a
+<a href="s6-fdholderd.html">s6-fdholderd</a> server process listening on
+<em>path</em>. </li>
+ <li> It attempts to pass a complete state - i.e. a set of file descriptors
+with identifiers and expiration dates - to the server. </li>
 </ul>
 
 <h2> Options </h2>
@@ -53,14 +49,26 @@ only here to protect users against programming errors (connecting to the
 wrong socket, for instance). </li>
 </ul>
 
+<h2> Exit codes </h2>
+
+<ul>
+ <li> 0: success. </li>
+ <li> 1: the server denied the operation. The meaning of the error messages
+is explained <a href="s6-fdholder-errorcodes.html">here</a>. </li>
+ <li> 100: wrong usage. </li>
+ <li> 111: system call failed - that includes attempting to connect to a
+nonexistent socket, or one where no <a href="s6-fdholderd.html">s6-fdholderd</a>
+daemon is listening. </li>
+</ul>
+
 <h2> Notes </h2>
 
 <ul>
  <li> The file descriptors to transmit to the server should of course be
-already open in the s6-fdholder-setdump program; also, s6-fdholder-setdump
+already open in the <tt>s6-fdholder-setdump</tt> program; also, <tt>s6-fdholder-setdump</tt>
 should have certain environment variables that describe that set of file
 descriptors. The format of the environment is the same as the one set by
-<a href="s6-fdholder-getdumpc.html">s6-fdholder-getdumpc</a>. </li>
+<a href="s6-fdholder-getdump.html">s6-fdholder-getdump</a>. </li>
  <li> Getting the whole state of a s6-fdholderd daemon requires specific
 privileges. Make sure you properly
 <a href="s6-fdholderd.html#configuration">configure the s6-fdholderd
-- 
cgit v1.3.1