summaryrefslogtreecommitdiff
path: root/doc/s6-fdholder-storec.html
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2015-01-26 22:26:57 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2015-01-26 22:26:57 +0000
commit8bffa1c19fd05f4f04dad4b5b98f85b94f23113c (patch)
treef4e25c3cdb7118db02a06c85b7862107a2074ba4 /doc/s6-fdholder-storec.html
parent49cb17940e403431566dc7b5a312624f14eb25d0 (diff)
downloads6-8bffa1c19fd05f4f04dad4b5b98f85b94f23113c.tar.xz
- added s6-fdholder-delete(c)
- small s6-fdholder-* fixes - s6-fdholder documentation (in review) - s6_svstatus_* bugfix (thanks Olivier Brunel)
Diffstat (limited to 'doc/s6-fdholder-storec.html')
-rw-r--r--doc/s6-fdholder-storec.html68
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/s6-fdholder-storec.html b/doc/s6-fdholder-storec.html
new file mode 100644
index 0000000..08180e4
--- /dev/null
+++ b/doc/s6-fdholder-storec.html
@@ -0,0 +1,68 @@
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>s6: the s6-fdholder-storec program</title>
+ <meta name="Description" content="s6: the s6-fdholder-storec program" />
+ <meta name="Keywords" content="s6 s6-fdholder fd-holding fd-holder fd storage unix socket activation" />
+ <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">s6</a><br />
+<a href="http://skarnet.org/software/">Software</a><br />
+<a href="http://skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The <tt>s6-fdholder-storec</tt> program </h1>
+
+<p>
+<tt>s6-fdholder-storec</tt> talks to a
+<a href="s6-fdholderd.html">fd-holding daemon</a> on its open
+descriptors 6 and 7, and passes it a copy of its standard
+input.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+ s6-fdholder-storec [ -T fdtimeout ] [ -t <em>timeout</em> ] <em>id</em>
+</pre>
+
+<ul>
+ <li> s6-fdholder-storec expects to talk to a listening
+<a href="s6-fdholderd.html">s6-fdholderd</a> program on its descriptors 6 and 7. </li>
+ <li> It attempts to pass a copy of its fd 0 (standard input) to s6-fdholderd,
+with identifier <em>id</em>. </li>
+ <li> It then exits 0, or 1 if the server returned an error. </li>
+</ul>
+
+<h2> Options </h2>
+
+<ul>
+ <li> <tt>-T&nbsp;<em>fdtimeout</em></tt>&nbsp;: 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&nbsp;<em>timeout</em></tt>&nbsp;: 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. </li>
+</ul>
+
+<h2> Notes </h2>
+
+<ul>
+ <li>s6-fdholder-storec is the "internal" version of
+<a href="s6-fdholder-store.html">s6-fdholder-store</a>. It simply
+expects to be run as a UCSPI client, i.e. talking to the server
+over descriptors 6 and 7, instead of connecting to the server
+itself. </li>
+ <li> The error messages for the s6-fdholder suite are explained
+<a href="s6-fdholder-errorcodes.html">here</a>. </li>
+</ul>
+
+</body>
+</html>