summaryrefslogtreecommitdiff
path: root/doc/s6-fdholder-listc.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/s6-fdholder-listc.html')
-rw-r--r--doc/s6-fdholder-listc.html68
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/s6-fdholder-listc.html b/doc/s6-fdholder-listc.html
new file mode 100644
index 0000000..47a2ec8
--- /dev/null
+++ b/doc/s6-fdholder-listc.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-listc program</title>
+ <meta name="Description" content="s6: the s6-fdholder-listc program" />
+ <meta name="Keywords" content="s6 s6-fdholder fd-holding fd-holder fd list 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-listc</tt> program </h1>
+
+<p>
+<tt>s6-fdholder-listc</tt> talks to a
+<a href="s6-fdholderd.html">fd-holding daemon</a> on its open
+descriptors 6 and 7. It prints on stdout the list of identifiers
+of all the fd currently held by the daemon, one per line.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+ s6-fdholder-listc [ -t <em>timeout</em> ]
+</pre>
+
+<ul>
+ <li> s6-fdholder-listc expects to talk to a listening
+<a href="s6-fdholderd.html">s6-fdholderd</a> program on its descriptors 6 and 7. </li>
+ <li> It gets the list of identifiers corresponding to the currently held
+file descriptors. It prints that list to stdout, one per line.
+ <li> It then exits 0, or 1 if the server returned an error. </li>
+</ul>
+
+<h2> Options </h2>
+
+<ul>
+<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-listc is the "internal" version of
+<a href="s6-fdholder-list.html">s6-fdholder-list</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>
+ <li> The list of identifiers is printed one per line; special
+characters - such as newline - are quoted. The output can be
+unquoted, for instance, by
+<tt><a href="http://skarnet.org/software/s6-portable-utils/s6-unquote-filter.html">s6-unquote-filter</a>
+-d ""</tt>. </li>
+</ul>
+
+</body>
+</html>