diff options
Diffstat (limited to 'doc/s6-fdholder-store.html')
| -rw-r--r-- | doc/s6-fdholder-store.html | 32 |
1 files changed, 19 insertions, 13 deletions
diff --git a/doc/s6-fdholder-store.html b/doc/s6-fdholder-store.html index 9a115f3..d0c3197 100644 --- a/doc/s6-fdholder-store.html +++ b/doc/s6-fdholder-store.html @@ -32,36 +32,42 @@ descriptors for the daemon to hold. </pre> <ul> - <li> s6-fdholder-store executes into <tt><a href="s6-ipcclient.html">s6-ipcclient</a> <em>path</em> -<a href="s6-fdholder-storec.html">s6-fdholder-storec</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-storec.html">s6-fdholder-storec</a> program transmits the desired -file descriptor 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 -file descriptor given by the user. </li> + <li> <tt>s6-fdholder-store</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 copy of its standard input, or of its descriptor +<em>fd</em>, to the server, with identifier <em>id</em>. </li> </ul> <h2> Options </h2> <ul> <li> <tt>-d <em>fd</em></tt> : store descriptor number <em>fd</em>. -By default, <em>fd</em> is 0 (i.e. the program's stdin will be stored). -s6-fdholder-store replaces its stdin with <em>fd</em> before executing into -<tt>s6-ipcclient <a href="s6-fdholder-storec.html">s6-fdholder-storec</a></tt>. </li> +By default, <em>fd</em> is 0 (i.e. the program's stdin will be stored). </li> <li> <tt>-T <em>fdtimeout</em></tt> : the descriptor is stored with an expiration time of <em>fdtimeout</em> milliseconds, which means the <a href="s6-fdholderd.html">s6-fdholderd</a> daemon will close and get rid of the descriptor after that time. By default, <em>fdtimeout</em> is 0, which means infinite - no expiration time. </li> -<li> <tt>-t <em>timeout</em></tt> : if the operation cannot be + <li> <tt>-t <em>timeout</em></tt> : if the operation cannot be processed in <em>timeout</em> milliseconds, then fail with an error message. Communications with the server should be near-instant, so this option is 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> Usage example </h2> <pre> |