s6

Mirror/fork of https://skarnet.org/software/s6/
git clone https://ccx.te2000.cz/git/s6
Log | Files | Refs | README | LICENSE

s6-fdholder-list.html (2063B)

      1 <html>
      2   <head>
      3     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
      4     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
      5     <meta http-equiv="Content-Language" content="en" />
      6     <title>s6: the s6-fdholder-list program</title>
      7     <meta name="Description" content="s6: the s6-fdholder-list program" />
      8     <meta name="Keywords" content="s6 s6-fdholder fd-holding fd-holder fd list unix socket activation" />
      9     <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
     10   </head>
     11 <body>
     12 
     13 <p>
     14 <a href="index.html">s6</a><br />
     15 <a href="//skarnet.org/software/">Software</a><br />
     16 <a href="//skarnet.org/">skarnet.org</a>
     17 </p>
     18 
     19 <h1> The <tt>s6-fdholder-list</tt> program </h1>
     20 
     21 <p>
     22 <tt>s6-fdholder-list</tt> lists the descriptors currently held by a
     23 <a href="s6-fdholderd.html">fd-holding daemon</a>.
     24 </p>
     25 
     26 <h2> Interface </h2>
     27 
     28 <pre>
     29      s6-fdholder-list [ -t <em>timeout</em> ] <em>path</em>
     30 </pre>
     31 
     32 <ul>
     33  <li> <tt>s6-fdholder-list</tt> connects to a
     34 <a href="s6-fdholderd.html">s6-fdholderd</a> server process listening on
     35 <em>path</em>. </li>
     36  <li> It gets the list of identifiers corresponding to the currently held
     37 file descriptors. It prints this list to stdout, one per line. </li>
     38 </ul>
     39 
     40 <h2> Options </h2>
     41 
     42 <ul>
     43  <li> <tt>-t&nbsp;<em>timeout</em></tt>&nbsp;: if the operation cannot be
     44 processed in <em>timeout</em> milliseconds, then fail with an error message.
     45 Communications with the server should be near-instant, so this option is
     46 only here to protect users against programming errors (connecting to the
     47 wrong socket, for instance). </li>
     48 </ul>
     49 
     50 <h2> Exit codes </h2>
     51 
     52 <ul>
     53  <li> 0: success. </li>
     54  <li> 1: the server denied the operation. The meaning of the error messages
     55 is explained <a href="s6-fdholder-errorcodes.html">here</a>. </li>
     56  <li> 100: wrong usage. </li>
     57  <li> 111: system call failed - this includes attempting to connect to a
     58 nonexistent socket, or one where no <a href="s6-fdholderd.html">s6-fdholderd</a>
     59 daemon is listening. </li>
     60 </ul>
     61 
     62 </body>
     63 </html>