s6-fdholder-delete.html (2369B)
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-delete program</title> 7 <meta name="Description" content="s6: the s6-fdholder-delete program" /> 8 <meta name="Keywords" content="s6 s6-fdholder fd-holding fd-holder fd delete deletion 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-delete</tt> program </h1> 20 21 <p> 22 <tt>s6-fdholder-delete</tt> connects to a 23 <a href="s6-fdholderd.html">fd-holding daemon</a> listening on a 24 Unix domain socket, and deletes a file descriptor from the 25 daemon storage. 26 </p> 27 28 <h2> Interface </h2> 29 30 <pre> 31 s6-fdholder-delete [ -t <em>timeout</em> ] <em>path</em> <em>id</em> 32 </pre> 33 34 <ul> 35 <li> <tt>s6-fdholder-delete</tt> connects to a 36 <a href="s6-fdholderd.html">s6-fdholderd</a> server process listening on 37 <em>path</em>. </li> 38 <li> It tells the server to close the file descriptor that has been 39 stored with identifier <em>id</em>. </li> 40 </ul> 41 42 <h2> Options </h2> 43 44 <ul> 45 <li> <tt>-t <em>timeout</em></tt> : if the operation cannot be 46 processed in <em>timeout</em> milliseconds, then fail with an error message. 47 Communications with the server should be near-instant, so this option is 48 only here to protect users against programming errors (connecting to the 49 wrong socket, for instance). </li> 50 </ul> 51 52 <h2> Exit codes </h2> 53 54 <ul> 55 <li> 0: success. </li> 56 <li> 1: the server denied the operation. The meaning of the error messages 57 is explained <a href="s6-fdholder-errorcodes.html">here</a>. </li> 58 <li> 100: wrong usage. </li> 59 <li> 111: system call failed - this includes attempting to connect to a 60 nonexistent socket, or one where no <a href="s6-fdholderd.html">s6-fdholderd</a> 61 daemon is listening. </li> 62 </ul> 63 64 <h2> Usage example </h2> 65 66 <pre> 67 s6-fdholder-delete /service/fdholderd/s MYSOCKET 68 </pre> 69 70 <p> 71 will tell an s6-fdholderd daemon listening on the 72 <tt>/service/fdholderd/s</tt> socket to close the file descriptor 73 dentified as MYSOCKET. 74 </p> 75 76 </body> 77 </html>